NVIDIA / NVIDIA/NeMo-Retriever
[DOC]: Add instruction for setting up the docker container for client example inside the notebook
Nobody has claimed this yet.
- 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
The instructions for setting up the Docker container to run the client example notebooks should be included in the notebook itself in addition to the README file. This is important because users might be directed to the notebook directly from the "Quickstart" guide without encountering the client_examples README. Consequently, they may encounter errors related to data paths and environment variables.
(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 client examples referenced by the client README and the Quickstart guide, then compare the notebook setup steps with the existing Docker instructions. Document the required data paths and environment variables inside the client example notebooks so users directed there can run them without consulting the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, jupyter-notebook, python
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100