NVIDIA / NVIDIA/NeMo-Retriever
[DOC]: better document the jobs and their expected output
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
https://github.com/NVIDIA/nv-ingest/tree/main/client
Describe the problems in the documentation
I was not able to retrieve results for a previously submitted job after a couple of minutes. It’s not clear whether this is the expected behavior. From the naming of the APIs, a developer may infer that they can retrieve results from a job that has already been run. Additionally, JobStates aren’t properly documented anywhere. It isn’t clear whether previous jobs are stored or not.
(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 in the client directory linked in the issue and inspect the job-related APIs and JobStates references. Document whether results from previously run jobs can be retrieved, whether jobs are persisted, and the expected behavior after submission; the work is done when these behaviors and states are clear to developers.
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
- Needs clarification
- Newbie friendliness
- 35/100