NVIDIA / NVIDIA/NeMo-Retriever

[DOC]: move the usage of tkinter for image inspection to the python notebook

Open
#114 0 comments 0 reactions 0 assignees View on GitHub

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#:~:text=We%20also%20provide%20a%20script%20for%20inspecting%20extracted%20images

Describe the problems in the documentation

nspection of images using tkinter would require downloading the JSON files since A100s and H100s won’t have display capability without a separate, dedicated graphics solution. Please remove this script from the quickstart and reference it elsewhere. Inspecting the images in the python notebook is more usable.

(Optional) Propose a correction or improvement

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README section linked in the issue and find the quickstart instructions for inspecting extracted images with tkinter. Identify the Python notebook that already supports image inspection, then remove the script from the quickstart and reference the notebook or its usage there; done means the quickstart no longer requires tkinter or display access.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.