NVIDIA / NVIDIA/NeMo-Retriever
[DOC]: add description for "Task" and "Job"
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
https://github.com/NVIDIA/nv-ingest/blob/main/README.md
Describe the problems in the documentation
Besides in the python_client_usage.py example, there is no description on what a Task or a Job constitutes. Please cover these key concepts in the README after the Quickstart section.
(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
Read the README linked in the issue, focusing on the Quickstart section, and compare its usage of Task and Job with the python_client_usage.py example. Add clear descriptions of both concepts after Quickstart, with wording consistent with the example; the README should explain what each represents without requiring readers to infer it from code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100