Skip to content

(doc) remove the invalid -y flag from uv pip install openai quick-start command#1816

Merged
edknv merged 100 commits intoNVIDIA:mainfrom
kheiss-uwzoo:kheiss/remove-y2
Apr 7, 2026
Merged

(doc) remove the invalid -y flag from uv pip install openai quick-start command#1816
edknv merged 100 commits intoNVIDIA:mainfrom
kheiss-uwzoo:kheiss/remove-y2

Conversation

@kheiss-uwzoo
Copy link
Copy Markdown
Collaborator

removed -v option from pip install openai:

Since uv does not support -y, the command fails when users run the quick-start instructions.

Fix:
Replace the incorrect command with the proper one:

bash
uv pip install openai

kheiss-uwzoo and others added 30 commits February 19, 2026 10:36
Update all hardcoded version references from 26.1.2 to 26.3.0-RC1
across helm charts, docker-compose, FastAPI, docs, and examples.

Made-with: Cursor
Co-authored-by: Jeremy Dyer <jdye64@gmail.com>
…ing long VLM captioning

Large PDFs with VLM captioning enabled can take 2-22+ hours depending on hardware.
The previous defaults (STATE_TTL=7200s, RESULT_DATA_TTL=3600s) caused job state to
expire mid-processing, resulting in 404 "Job ID not found or state has expired" errors
even though the pipeline completed successfully.

Raises both defaults to 172800s (48 hours), providing sufficient headroom for all
observed workloads. Users can still override via RESULT_DATA_TTL_SECONDS and
STATE_TTL_SECONDS environment variables.

Fixes: Customer bug 5914605

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
kheiss-uwzoo and others added 21 commits March 25, 2026 11:28
…t pipeline by removing references to deprecated PDF extractors and obsolete OCR API usage left over from the NeMo Retriever Library transition. (NVIDIA#1727)
Co-authored-by: sosahi <syousefisahi@nvidia.com>
…ine; misc README/Helm fixesUpdating files per bugs 5966185, 5966211, and 5966281 (NVIDIA#1742)

Co-authored-by: sosahi <syousefisahi@nvidia.com>
…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
```
@kheiss-uwzoo kheiss-uwzoo requested review from a team as code owners April 7, 2026 22:47
@kheiss-uwzoo kheiss-uwzoo requested a review from ChrisJar April 7, 2026 22:47
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 7, 2026

Greptile Summary

This PR fixes a broken quickstart instruction in nemo_retriever/README.md — the previous uv pip install -y openai command failed because uv pip install does not support the -y flag (a conda/legacy pip convention). The corrected uv pip install openai on line 158 is the right fix.

Confidence Score: 5/5

Safe to merge — trivial documentation fix with no behavioral or API changes.

Single-line doc correction removing an unsupported flag from a shell command; no code logic, model lifecycle, or public API is affected.

No files require special attention.

Vulnerabilities

No security concerns identified.

Important Files Changed

Filename Overview
nemo_retriever/README.md Corrects broken install command (uv pip install -y openaiuv pip install openai); one minor prose inconsistency at line 203 remains

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["uv venv retriever --python 3.12"] --> B["uv pip install nemo-retriever nv-ingest-*"]
    B --> C["uv pip install torch torchvision\n(CUDA 13 index)"]
    C --> D[Run ingestion pipeline]
    D --> E{Need LLM answers?}
    E -- Yes --> F["uv pip install openai\nexport NVIDIA_API_KEY=..."]
    F --> G["Query build.nvidia.com LLM\n(OpenAI-compatible API)"]
    E -- No --> H["Query embeddings directly\nRetriever.query()"]
Loading

Comments Outside Diff (1)

  1. nemo_retriever/README.md, line 203 (link)

    P2 Inconsistent package manager reference in prose

    This sentence uses pip install cairosvg while every other install instruction in this guide uses uv pip. The code block immediately below already shows the correct uv pip install form — only this prose description needs updating.

    Prompt To Fix With AI
    This is a comment left during a code review.
    Path: nemo_retriever/README.md
    Line: 203
    
    Comment:
    **Inconsistent package manager reference in prose**
    
    This sentence uses `pip install cairosvg` while every other install instruction in this guide uses `uv pip`. The code block immediately below already shows the correct `uv pip install` form — only this prose description needs updating.
    
    
    
    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: 203

Comment:
**Inconsistent package manager reference in prose**

This sentence uses `pip install cairosvg` while every other install instruction in this guide uses `uv pip`. The code block immediately below already shows the correct `uv pip install` form — only this prose description needs updating.

```suggestion
For SVG files, install the optional `cairosvg` dependency with `uv pip install "cairosvg>=2.7.0"`. 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 (1): Last reviewed commit: "Merge branch 'main' into kheiss/remove-y..." | Re-trigger Greptile

@kheiss-uwzoo
Copy link
Copy Markdown
Collaborator Author

Greptile Summary
This PR ports documentation updates from PR #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)

  1. nemo_retriever/README.md, line 158 (link)
    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

@edknv edknv changed the title Kheiss/remove y2 (doc) remove the invalid -y flag from uv pip install openai quick-start command Apr 7, 2026
@edknv edknv merged commit ff68534 into NVIDIA:main Apr 7, 2026
6 checks passed
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.

8 participants