NVIDIA / NVIDIA/NeMo-Retriever
[DOC]: improve the error and exception handling in the example notebook
Open
Nobody has claimed this yet.
doc
- Dominant language
- Python
- Stars
- 3k
- Forks
- 349
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 116
Description
How would you describe the priority of this documentation request
None
Please provide a link or source to the relevant docs
Describe the problems in the documentation
I got a [500 Internal Server Error] when I submitted the job with the store and vdb_upload tasks in the example python client notebook. This appears to be an issue with minio access but the error message thrown is very misleading.
(Optional) Propose a correction or improvement
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Examples section in the client documentation and the example Python client notebook referenced in the issue. Reproduce submission with the store and vdb_upload tasks, then inspect how the MinIO-related 500 error is reported. Done means the example documents or presents the failure with an accurate, actionable error message.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100