Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC]: better document the jobs and their expected output #134

Open
sosahi opened this issue Oct 2, 2024 · 0 comments
Open

[DOC]: better document the jobs and their expected output #134

sosahi opened this issue Oct 2, 2024 · 0 comments
Labels
doc Improvements or additions to documentation

Comments

@sosahi
Copy link
Collaborator

sosahi commented Oct 2, 2024

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

@sosahi sosahi added the doc Improvements or additions to documentation label Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant