Skip to content

remove 26.05 RC doc references#2213

Open
kheiss-uwzoo wants to merge 7 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/nrl-readme-ga-pypi-pin
Open

remove 26.05 RC doc references#2213
kheiss-uwzoo wants to merge 7 commits into
NVIDIA:mainfrom
kheiss-uwzoo:docs/nrl-readme-ga-pypi-pin

Conversation

@kheiss-uwzoo

@kheiss-uwzoo kheiss-uwzoo commented Jun 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Remove stale 26.05-RC1 references from README and Helm docs now that 26.05 is GA (26.5.0).
  • Quickstart installs: drop version pins (==26.05-RC1 / ==26.5.0) per @jperez999 review — use unpinned uv pip install nemo-retriever[...], consistent with extraction docs and other README extras ([multimedia], [llm], etc.).
  • Root README.md: branch pointer describes GA 26.5.0 instead of RC build tags.
  • nemo_retriever/helm/README.md: air-gapped mirror example tag updated from 26.05-RC1 to 26.5.0 (container tags must stay explicit).

Why unpinned quickstart installs? Published extraction docs already use unpinned pip install nemo-retriever[...]. Pinning in the quickstart created doc drift (stale 26.05-RC1 after GA). GA version is still documented in the root README branch pointer and Helm mirror example; users who need exact coordinates are directed to the prerequisites page.

26.05 is GA — no further RC builds.

Test plan

  • Verified 26.5.0 is the current latest on PyPI
  • Grep: no 26.05-RC / RC builds left in changed *.md docs
  • @jperez999 re-review / merge

Replace stale 26.05-RC1 install examples in the library README and Helm air-gap section now that 26.5.0 is published on PyPI.
@kheiss-uwzoo kheiss-uwzoo requested review from a team as code owners June 5, 2026 22:44
@kheiss-uwzoo kheiss-uwzoo requested a review from nkmcalli June 5, 2026 22:44
@greptile-apps

greptile-apps Bot commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Documentation-only PR that removes all remaining 26.05-RC1 references across three README files now that the 26.05 line is GA as PyPI 26.5.0. The docs/docs/extraction/releasenotes.md update described in the PR summary was handled in an earlier commit on this branch that has since been absorbed into main, so the net diff for that file is zero.

  • README.md: Branch pointer sentence updated to describe the 26.05 branch as GA 26.5.0 instead of listing RC build tags.
  • nemo_retriever/README.md: RC version specifiers removed from all three quickstart uv pip install examples; installs are now unpinned.
  • nemo_retriever/helm/README.md: Air-gapped mirroring example tag updated from 26.05-RC1 to 26.5.0.

Confidence Score: 5/5

Safe to merge — all changes are documentation text updates with no code, configuration, or schema modifications.

Every change in this PR is a text edit to Markdown files: a one-line branch description update, removal of RC version specifiers from install examples, and a single tag string update in the Helm README. None of the changes affect runnable code, deployment configuration, or schema definitions.

No files require special attention.

Important Files Changed

Filename Overview
README.md Replaces RC build tag language with GA 26.5.0 description and cleans up the branch pointer sentence.
nemo_retriever/README.md Removes ==26.05-RC1 version specifiers from three uv pip install examples, leaving installs unpinned.
nemo_retriever/helm/README.md Updates the air-gapped mirroring example tag from 26.05-RC1 to 26.5.0 — clean one-line change.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User follows README install guide] --> B{Which install path?}
    B --> C["Local GPU inference\nuv pip install 'nemo-retriever[local]'"]
    B --> D["Remote NIM only\nuv pip install nemo-retriever"]
    B --> E["Nemotron Parse\nuv pip install 'nemo-retriever[nemotron-parse]'"]
    C --> F[Install matching ingest client + runtime wheels]
    D --> F
    E --> F
    F --> G[Refer to NeMo Retriever Library prerequisites\nfor exact PyPI coordinates]
Loading

Reviews (7): Last reviewed commit: "Merge branch 'main' into docs/nrl-readme..." | Re-trigger Greptile

Update the repo README and release notes for GA PyPI/Helm coordinates; library quickstart and Helm air-gap examples were already pinned to 26.5.0.
@kheiss-uwzoo kheiss-uwzoo changed the title docs(nrl): pin quickstart installs to GA PyPI 26.5.0 docs(nrl): GA 26.5.0 install pins; remove 26.05 RC doc references Jun 5, 2026
@kheiss-uwzoo kheiss-uwzoo mentioned this pull request Jun 5, 2026
2 tasks
Keep the upgrade sentence as a link to the Helm README only; GA install pins remain in the library quickstart and packaging section.
@kheiss-uwzoo kheiss-uwzoo changed the title docs(nrl): GA 26.5.0 install pins; remove 26.05 RC doc references remove 26.05 RC doc references Jun 5, 2026
@kheiss-uwzoo kheiss-uwzoo added the doc Improvements or additions to documentation label Jun 5, 2026
@kheiss-uwzoo kheiss-uwzoo self-assigned this Jun 8, 2026
Comment thread docs/docs/extraction/releasenotes.md Outdated

### Packaging and platform

- GA PyPI install: `uv pip install nemo-retriever==26.5.0` (see the library [quickstart](https://github.com/NVIDIA/NeMo-Retriever/tree/main/nemo_retriever#setup-your-environment))

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Don't we want to remove all 26.5.0 references? Couldn't this just be uv pip install nemo-retriever

Comment thread nemo_retriever/README.md Outdated
uv venv retriever --python 3.12
source retriever/bin/activate
uv pip install "nemo-retriever[local]==26.05-RC1"
uv pip install "nemo-retriever[local]==26.5.0"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

same as above can't we drop the ==26.5.0?

Comment thread nemo_retriever/README.md Outdated
uv venv retriever --python 3.12
source retriever/bin/activate
uv pip install nemo-retriever==26.05-RC1
uv pip install nemo-retriever==26.5.0

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

same

Comment thread nemo_retriever/README.md Outdated

```bash
uv pip install "nemo-retriever[nemotron-parse]==26.05-RC1"
uv pip install "nemo-retriever[nemotron-parse]==26.5.0"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

same

Remove ==26.5.0 from quickstart install commands and the redundant
GA install bullet in release notes so docs match unpinned conventions.
Comment thread nemo_retriever/README.md
uv venv retriever --python 3.12
source retriever/bin/activate
uv pip install "nemo-retriever[local]==26.05-RC1"
uv pip install "nemo-retriever[local]"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 The PR description says these commands should be pinned to the GA 26.5.0 release, but the diff removes the version specifiers entirely. Without a pin, users running these commands will install whatever the current latest version of nemo-retriever is on PyPI, which may not match the documentation or the companion nv-ingest-client/runtime wheels that the following paragraph instructs them to install "at the same version". This breaks the documented reproducibility guarantee and could cause compatibility mismatches as future releases ship.

Suggested change
uv pip install "nemo-retriever[local]"
uv pip install "nemo-retriever[local]==26.5.0"
Prompt To Fix With AI
This is a comment left during a code review.
Path: nemo_retriever/README.md
Line: 47

Comment:
The PR description says these commands should be pinned to the GA `26.5.0` release, but the diff removes the version specifiers entirely. Without a pin, users running these commands will install whatever the current latest version of `nemo-retriever` is on PyPI, which may not match the documentation or the companion `nv-ingest-client`/runtime wheels that the following paragraph instructs them to install "at the same version". This breaks the documented reproducibility guarantee and could cause compatibility mismatches as future releases ship.

```suggestion
uv pip install "nemo-retriever[local]==26.5.0"
```

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

Comment thread nemo_retriever/README.md
uv venv retriever --python 3.12
source retriever/bin/activate
uv pip install nemo-retriever==26.05-RC1
uv pip install nemo-retriever

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 Same missing version pin as the [local] extra above — the base package install should also be pinned to the GA release so it is consistent with the surrounding version guidance.

Suggested change
uv pip install nemo-retriever
uv pip install nemo-retriever==26.5.0
Prompt To Fix With AI
This is a comment left during a code review.
Path: nemo_retriever/README.md
Line: 58

Comment:
Same missing version pin as the `[local]` extra above — the base package install should also be pinned to the GA release so it is consistent with the surrounding version guidance.

```suggestion
uv pip install nemo-retriever==26.5.0
```

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

Comment thread nemo_retriever/README.md

```bash
uv pip install "nemo-retriever[nemotron-parse]==26.05-RC1"
uv pip install "nemo-retriever[nemotron-parse]"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 Same missing version pin as the two commands above — the [nemotron-parse] extra should be pinned to 26.5.0 for the same reasons.

Suggested change
uv pip install "nemo-retriever[nemotron-parse]"
uv pip install "nemo-retriever[nemotron-parse]==26.5.0"
Prompt To Fix With AI
This is a comment left during a code review.
Path: nemo_retriever/README.md
Line: 68

Comment:
Same missing version pin as the two commands above — the `[nemotron-parse]` extra should be pinned to `26.5.0` for the same reasons.

```suggestion
uv pip install "nemo-retriever[nemotron-parse]==26.5.0"
```

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

@kheiss-uwzoo kheiss-uwzoo requested a review from jperez999 June 9, 2026 17:04
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

Successfully merging this pull request may close these issues.

2 participants