Skip to content

(doc) add svg file support documentation#1812

Merged
edknv merged 5 commits intoNVIDIA:mainfrom
edknv:edwardk/doc-nrl-svg
Apr 7, 2026
Merged

(doc) add svg file support documentation#1812
edknv merged 5 commits intoNVIDIA:mainfrom
edknv:edwardk/doc-nrl-svg

Conversation

@edknv
Copy link
Copy Markdown
Collaborator

@edknv edknv commented Apr 7, 2026

Description

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.
  • If adjusting docker-compose.yaml environment variables have you ensured those are mimicked in the Helm values.yaml file.

@edknv edknv requested a review from kheiss-uwzoo April 7, 2026 18:11
@edknv edknv requested review from a team as code owners April 7, 2026 18:11
@edknv edknv requested a review from ChrisJar April 7, 2026 18:11
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 7, 2026

Greptile Summary

This PR documents SVG file support in the supported file types list (overview.md) and the installation guide (README.md), correctly noting the library-only availability and the optional cairosvg dependency. The only finding is a minor inconsistency on nemo_retriever/README.md line 203 where the prose says pip install cairosvg but the code block directly below it uses uv pip install "nemo-retriever[svg]" — the prose should be updated to match the project's uv-based toolchain.

Confidence Score: 5/5

Documentation-only PR is safe to merge.

Both changed files are markdown documentation with no code changes. The single finding is a P2 prose/code inconsistency that does not affect functionality.

nemo_retriever/README.md has a minor prose inconsistency on line 203 (pip vs uv pip).

Important Files Changed

Filename Overview
docs/docs/extraction/overview.md Adds svg to the supported file types list with correct library-only and cairosvg dependency notes; alphabetically ordered correctly.
nemo_retriever/README.md Adds SVG installation instructions; minor prose inconsistency references pip install while the code block below uses uv pip install.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User wants SVG support] --> B{Deployment mode?}
    B -- Library Mode --> C[uv pip install nemo-retriever svg]
    B -- Container Mode --> D[Not supported]
    C --> E[cairosvg>=2.7.0 installed]
    E --> F[SVG files can be ingested]
    D --> G[Use a different file type]
Loading
Prompt To Fix All With AI
This is a comment left during a code review.
Path: nemo_retriever/README.md
Line: 203

Comment:
**Prose references `pip` instead of `uv`**

The sentence tells users to run `` `pip install cairosvg` `` but the code block immediately below uses `uv pip install`. Since the project's standard tooling is `uv`, the prose should align with the code block to avoid confusion.

```suggestion
For SVG files, install the optional `cairosvg` dependency. SVG support is available in the NeMo Retriever Library, but not in the container deployment. `cairosvg` requires network access to install, so it will not work in air-gapped environments.
```

How can I resolve this? If you propose a fix, please make it concise.

Reviews (3): Last reviewed commit: "Update nemo_retriever/README.md" | Re-trigger Greptile

Copy link
Copy Markdown
Collaborator

@kheiss-uwzoo kheiss-uwzoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed the sentence structure

@kheiss-uwzoo kheiss-uwzoo self-requested a review April 7, 2026 18:49
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@edknv edknv merged commit a596475 into NVIDIA:main Apr 7, 2026
7 checks passed
@edknv edknv deleted the edwardk/doc-nrl-svg branch April 7, 2026 19:53
kheiss-uwzoo added a commit to kheiss-uwzoo/nv-ingest that referenced this pull request Apr 7, 2026
Greptile Summary
This PR ports documentation updates from PR NVIDIA#1812 to the 26.03 branch, refreshing the extraction overview (docs/docs/extraction/overview.md) and the library-mode quick start README (nemo_retriever/README.md) with CUDA 13 requirements, updated install commands, and new pipeline examples.

nemo_retriever/README.md line 158: uv pip install -y openai uses an invalid -y flag — this is an apt/apt-get convention that uv pip install does not support, so the command will fail with an unrecognized option error for any user who follows the quick start guide.
Confidence Score: 4/5
Safe to merge after fixing the invalid -y flag in the uv install command on line 158.

One P1 finding: a broken shell command that will error when copy-pasted by users following the quick start guide. All other changes are prose-only documentation with no functional issues.

nemo_retriever/README.md — invalid uv pip install -y openai on line 158.

Important Files Changed


Filename	Overview
docs/docs/extraction/overview.md	Documentation-only overview update describing supported file types and related topics; no issues found.
nemo_retriever/README.md	Quick start README updated with CUDA 13 setup and pipeline examples; contains an invalid -y flag in a uv pip install command on line 158.
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["Input Documents\nPDF / DOCX / HTML / Audio / Video"] --> B["create_ingestor()"]
    B --> C[".files()"]
    C --> D[".extract()\nPage Elements + OCR + Table Structure"]
    D --> E{Optional Steps}
    E --> F[".split()\nToken-based chunking"]
    E --> G[".embed()\nEmbedding generation"]
    G --> H[".vdb_upload()\nLanceDB storage"]
    H --> I["Retriever.query()\nSemantic search"]
    I --> J["LLM Answer Generation"]
Loading
Comments Outside Diff (1)
nemo_retriever/README.md, line 158 (link)

P1 Invalid flag for uv pip install

The -y flag is not recognized by uv pip install — it is an apt-get/apt convention, not a uv flag. Running this command will fail with an unrecognized option error for any user who copy-pastes it from the quick start guide.

Prompt To Fix With AI
This is a comment left during a code review.
Path: nemo_retriever/README.md
Line: 158

Comment:
**Invalid flag for `uv pip install`**

The `-y` flag is not recognized by `uv pip install` — it is an `apt-get`/`apt` convention, not a `uv` flag. Running this command will fail with an unrecognized option error for any user who copy-pastes it from the quick start guide.

How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix All With AI
This is a comment left during a code review.
Path: nemo_retriever/README.md
Line: 158

Comment:
**Invalid flag for `uv pip install`**

The `-y` flag is not recognized by `uv pip install` — it is an `apt-get`/`apt` convention, not a `uv` flag. Running this command will fail with an unrecognized option error for any user who copy-pastes it from the quick start guide.

```suggestion
uv pip install openai
```

How can I resolve this? If you propose a fix, please make it concise.
kheiss-uwzoo added a commit to kheiss-uwzoo/nv-ingest that referenced this pull request Apr 7, 2026
Greptile Summary
This PR ports documentation updates from PR NVIDIA#1812 to the 26.03 branch, refreshing the extraction overview (docs/docs/extraction/overview.md) and the library-mode quick start README (nemo_retriever/README.md) with CUDA 13 requirements, updated install commands, and new pipeline examples.

nemo_retriever/README.md line 158: uv pip install -y openai uses an invalid -y flag — this is an apt/apt-get convention that uv pip install does not support, so the command will fail with an unrecognized option error for any user who follows the quick start guide. Confidence Score: 4/5
Safe to merge after fixing the invalid -y flag in the uv install command on line 158.

One P1 finding: a broken shell command that will error when copy-pasted by users following the quick start guide. All other changes are prose-only documentation with no functional issues.

nemo_retriever/README.md — invalid uv pip install -y openai on line 158.

Important Files Changed


Filename Overview
docs/docs/extraction/overview.md Documentation-only overview update describing supported file types and related topics; no issues found. nemo_retriever/README.md Quick start README updated with CUDA 13 setup and pipeline examples; contains an invalid -y flag in a uv pip install command on line 158. Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["Input Documents\nPDF / DOCX / HTML / Audio / Video"] --> B["create_ingestor()"]
B --> C[".files()"]
C --> D[".extract()\nPage Elements + OCR + Table Structure"]
D --> E{Optional Steps}
E --> F[".split()\nToken-based chunking"]
E --> G[".embed()\nEmbedding generation"]
G --> H[".vdb_upload()\nLanceDB storage"]
H --> I["Retriever.query()\nSemantic search"]
I --> J["LLM Answer Generation"]
Loading
Comments Outside Diff (1)
nemo_retriever/README.md, line 158 (link)

P1 Invalid flag for uv pip install

The -y flag is not recognized by uv pip install — it is an apt-get/apt convention, not a uv flag. Running this command will fail with an unrecognized option error for any user who copy-pastes it from the quick start guide.

Prompt To Fix With AI
This is a comment left during a code review.
Path: nemo_retriever/README.md
Line: 158

Comment:
Invalid flag for uv pip install

The -y flag is not recognized by uv pip install — it is an apt-get/apt convention, not a uv flag. Running this command will fail with an unrecognized option error for any user who copy-pastes it from the quick start guide.

How can I resolve this? If you propose a fix, please make it concise. Prompt To Fix All With AI
This is a comment left during a code review.
Path: nemo_retriever/README.md
Line: 158

Comment:
Invalid flag for uv pip install

The -y flag is not recognized by uv pip install — it is an apt-get/apt convention, not a uv flag. Running this command will fail with an unrecognized option error for any user who copy-pastes it from the quick start guide.

uv pip install openai
How can I resolve this? If you propose a fix, please make it concise.

Description
Checklist
 I am familiar with the Contributing Guidelines.
 New or existing tests cover these changes.
 The documentation is up to date with these changes.
 If adjusting docker-compose.yaml environment variables have you ensured those are mimicked in the Helm values.yaml file.
kheiss-uwzoo added a commit to kheiss-uwzoo/nv-ingest that referenced this pull request Apr 7, 2026
…ll openai command:

Greptile Summary
This PR was explicitly created to remove the invalid -y flag from the uv pip install openai quick-start command (porting from PR NVIDIA#1812), but the fix was never committed — line 158 of nemo_retriever/README.md in the HEAD still reads uv pip install -y openai.

P1 (nemo_retriever/README.md line 158): uv pip install -y openai remains unchanged; uv does not accept -y and the command will error for every user following the guide.
Confidence Score: 4/5
Not safe to merge — the primary stated fix (removing -y) was not applied and the broken install command remains in the quick-start guide.

One P1 finding remains: the uv pip install -y openai command on line 158 still carries the invalid -y flag. This will cause an unrecognized-option error for every user following the guide, which is the exact defect this PR was created to fix.

nemo_retriever/README.md line 158

Vulnerabilities
No security concerns identified.

Important Files Changed






Filename	Overview
nemo_retriever/README.md	Quick-start README updated with CUDA 13 setup and pipeline examples; the stated fix (removing -y from uv pip install on line 158) was not applied — the invalid flag is still present.
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["User follows Quick Start guide"] --> B["uv pip install -y openai"]
    B --> C{"uv recognises -y flag?"}
    C -- No --> D["Error: unrecognized option '-y'\nInstall fails"]
    C -- Yes --> E["openai installed successfully"]
    D --> F["Fix: remove -y flag"]
    F --> G["uv pip install openai"]
    G --> E
Loading
Comments Outside Diff (1)
nemo_retriever/README.md, line 158 (link)

P1 Fix not applied — -y flag still present

The PR title states this removes -y from the uv pip install command, but the HEAD commit on line 158 still reads uv pip install -y openai. The -y flag is an apt/apt-get convention; uv pip install does not recognise it and will exit with an unrecognized-option error for every user who copy-pastes this quick-start command.

Prompt To Fix With AI
This is a comment left during a code review.
Path: nemo_retriever/README.md
Line: 158

Comment:
**Fix not applied — `-y` flag still present**

The PR title states this removes `-y` from the `uv pip install` command, but the HEAD commit on line 158 still reads `uv pip install -y openai`. The `-y` flag is an `apt`/`apt-get` convention; `uv pip install` does not recognise it and will exit with an unrecognized-option error for every user who copy-pastes this quick-start command.

How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix All With AI
This is a comment left during a code review.
Path: nemo_retriever/README.md
Line: 158

Comment:
**Fix not applied — `-y` flag still present**

The PR title states this removes `-y` from the `uv pip install` command, but the HEAD commit on line 158 still reads `uv pip install -y openai`. The `-y` flag is an `apt`/`apt-get` convention; `uv pip install` does not recognise it and will exit with an unrecognized-option error for every user who copy-pastes this quick-start command.

```suggestion
uv pip install openai
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants