docs: Link uv's installation instructions to uv's website #837

wangshangsam · 2025-08-05T02:30:23Z

What does this PR do ?

Link uv's installation instructions to uv's website.
Add a parsing callback in docs/conf.py to convert GitHub alerts in Markdowns into RST properly. (since myst-parser doesn't seem to support it).
Replace pyrefly's pre-commit hook from a repo hook to a local hook that runs pyrefly via uv's dev environment.

Issues

There are situations where pip install uv is not suitable. For example, for conda users who have a default base conda environment, pip install uv would only install uv into the base environment; in this case, using the standalone installer would be more suitable. Therefore, this PR replaces pip install uv with a link to the installation instructions from uv's website.
Myst-parser doesn't seem to support converting GitHub alerts
When running pre-commit, since pyrefly's .pre-commit-hooks.yaml (that Meta people wrote) doesn't launch pyrefly through uv, an Executable pyrefly not found is thrown.

Usage

N/A

Before your PR is "Ready for review"

Pre checks:

Make sure you read and followed Contributor guidelines
Did you write any new necessary tests?
Did you run the unit tests and functional tests locally? Visit our Testing Guide for how to run tests
Did you add or update any necessary documentation? Visit our Document Development Guide for how to write, build and test the docs.

Additional Information

Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca>

terrykong

great change. good point about uv install. i didn't realize that markdown had builtin admonitions.

I tried rendering it in myst-parser and sadly it doesn't recognize.

is there a way to get it to work? if not, we probably need the front page readme to be "vanilla" markdown so it renders in both places just fine (and we can use more specific myst-parser stuff in the docs/ folder)

wangshangsam · 2025-08-06T19:10:09Z

is there a way to get it to work?

There might be one. Something alone the direction of the adding following in conf.py:

_GITHUB_ADMONITIONS = {
    "> [!NOTE]": "note",
    "> [!TIP]": "tip",
    "> [!IMPORTANT]": "important",
    "> [!WARNING]": "warning",
    "> [!CAUTION]": "caution",
}

def run_convert_github_admonitions_to_rst(app, filename, lines):
    # loop through lines, replace github admonitions
    for i, orig_line in enumerate(lines):
        orig_line_splits = orig_line.split("\n")
        replacing = False
        for j, line in enumerate(orig_line_splits):
            # look for admonition key
            for admonition_key in _GITHUB_ADMONITIONS:
                if admonition_key in line:
                    line = line.replace(admonition_key, ":::{" + _GITHUB_ADMONITIONS[admonition_key] + "}\n")
                    # start replacing quotes in subsequent lines
                    replacing = True
                    break
            else:
                # replace indent to match directive
                if replacing and "> " in line:
                    line = line.replace("> ", "  ")
                elif replacing:
                    # missing "> ", so stop replacing and terminate directive
                    line = f"\n:::\n{line}"
                    replacing = False
            # swap line back in splits
            orig_line_splits[j] = line
        # swap line back in original
        lines[i] = "\n".join(orig_line_splits)


def setup(app):
    app.connect("source-read", run_convert_github_admonitions_to_rst)

(reference: executablebooks/MyST-Parser#845 (comment))

I'll give this a try. If it doesn't work, I'll roll back to vanilla markdown.

wangshangsam · 2025-08-07T21:00:20Z

Works like a charm :)

I'm pushing the conf.py change now.

terrykong · 2025-08-07T21:33:18Z

nice! just mentioning this issue which might be solvable with the mechanic you've introduced

#577

not blocking this PR but just leaving a comment as ref

…-Parser. Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca>

…o#837) Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca> Signed-off-by: Qidong Su <qidongs@nvidia.com>

commit b246e55 Author: Youngeun Kwon <youngeunk@nvidia.com> Date: Mon Aug 25 15:05:48 2025 -0700 update the script Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com> commit 5315a6b Author: Youngeun Kwon <youngeunk@nvidia.com> Date: Mon Aug 25 13:59:16 2025 -0700 script update Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com> commit 4437402 Author: Youngeun Kwon <youngeunk@nvidia.com> Date: Tue Jul 15 17:42:23 2025 -0700 local Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com> wip Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com> add script Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com> update script Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com> update script Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com> interactive Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com> commit b721703 Author: Charlie Truong <chtruong@nvidia.com> Date: Mon Aug 18 11:22:54 2025 -0500 build: Fix pytorch image ref in Dockerfile.ngc_pytorch (NVIDIA-NeMo#936) Signed-off-by: Charlie Truong <chtruong@nvidia.com> commit 70b9666 Author: Charlie Truong <chtruong@nvidia.com> Date: Sun Aug 17 21:17:58 2025 -0500 build: Add Dockerfile that uses NGC pytorch image (NVIDIA-NeMo#897) Signed-off-by: Charlie Truong <chtruong@nvidia.com> commit df31c1b Author: pjin-nvidia <pjin@nvidia.com> Date: Thu Aug 14 18:34:50 2025 -0700 feat: chunked logprob calculation with deferred fp32 cast to help with OOM (NVIDIA-NeMo#918) Signed-off-by: Peter Jin <pjin@nvidia.com> commit 83c6bfc Author: yuki <48991475+yuki-666@users.noreply.github.com> Date: Thu Aug 14 21:48:55 2025 +0800 refactor: split sync/async vllm worker ([1/2] of refactor vllm worker) (NVIDIA-NeMo#900) Signed-off-by: Yuki Huang <yukih@nvidia.com> commit 9f7825e Author: Rayen <130129397+RayenTian@users.noreply.github.com> Date: Thu Aug 14 12:38:27 2025 +0800 feat: Add TP to embed_tokens and lm_head for Gemma models (NVIDIA-NeMo#879) Signed-off-by: ruit <ruit@nvidia.com> commit e1f56c4 Author: Terry Kong <terrycurtiskong@gmail.com> Date: Tue Aug 12 13:09:37 2025 -0700 feat: add diagnostic script for problematic embeddings (NVIDIA-NeMo#896) Signed-off-by: Terry Kong <terryk@nvidia.com> commit 223bfa8 Author: Gerald Shen <119401249+gshennvm@users.noreply.github.com> Date: Mon Aug 11 18:19:52 2025 -0700 feat: add nemotron5 sharding (NVIDIA-NeMo#481) Signed-off-by: Terry Kong <terryk@nvidia.com> Co-authored-by: Terry Kong <terryk@nvidia.com> commit 18b9e2c Author: Terry Kong <terrycurtiskong@gmail.com> Date: Mon Aug 11 15:08:52 2025 -0700 test: lower step count on gemma nightly test to finish within 4 hours (NVIDIA-NeMo#880) Signed-off-by: Terry Kong <terryk@nvidia.com> commit 8fd8c96 Author: guyueh1 <140554423+guyueh1@users.noreply.github.com> Date: Mon Aug 11 10:46:29 2025 -0700 feat: Fix and enhances for Nsight system profiling (NVIDIA-NeMo#865) Signed-off-by: Guyue Huang <guyueh@nvidia.com> commit 2b87def Author: Qidong Su <soodoshll@gmail.com> Date: Fri Aug 8 18:54:20 2025 -0400 fix: OOM in deepscaler1.5b with sequence length = 16/24k (NVIDIA-NeMo#875) Signed-off-by: Qidong Su <qidongs@nvidia.com> commit fecf71e Author: Rayen <130129397+RayenTian@users.noreply.github.com> Date: Sat Aug 9 06:42:07 2025 +0800 fix: remove tie weight check (NVIDIA-NeMo#700) Signed-off-by: ruit <ruit@nvidia.com> commit d45ff3f Author: Terry Kong <terrycurtiskong@gmail.com> Date: Fri Aug 8 10:07:02 2025 -0700 test: add deepscaler tests + pipe-clean configs + fix eval for deepscaler (NVIDIA-NeMo#866) Signed-off-by: Terry Kong <terryk@nvidia.com> commit d73c942 Author: Anna Shors <ashors@nvidia.com> Date: Fri Aug 8 09:27:15 2025 -0700 feat: qwen3 export to HF (NVIDIA-NeMo#873) Signed-off-by: Abdalgader Abubaker <136640907+abdalgader-a@users.noreply.github.com> Signed-off-by: Anna Shors <ashors@nvidia.com> Co-authored-by: Abdalgader Abubaker <136640907+abdalgader-a@users.noreply.github.com> commit e924d33 Author: Shang Wang <samshang.wang@mail.utoronto.ca> Date: Fri Aug 8 12:15:34 2025 -0400 docs: Link uv's installation instructions to uv's website (NVIDIA-NeMo#837) Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca> commit bbbb3d6 Author: yuki <48991475+yuki-666@users.noreply.github.com> Date: Fri Aug 8 23:26:15 2025 +0800 fix: fix non-colocated with cpu_offload enabled (NVIDIA-NeMo#861) Signed-off-by: Yuki Huang <yukih@nvidia.com> commit 88a399e Author: yuki <48991475+yuki-666@users.noreply.github.com> Date: Fri Aug 8 14:04:08 2025 +0800 chore: remove old fsdp1 unit test (NVIDIA-NeMo#871) Signed-off-by: Yuki Huang <yukih@nvidia.com> commit b8a89a9 Author: yuki <48991475+yuki-666@users.noreply.github.com> Date: Fri Aug 8 13:56:19 2025 +0800 feat: support non-colocated in mcore (NVIDIA-NeMo#613) Signed-off-by: Yuki Huang <yukih@nvidia.com> commit 5910abb Author: Anna Shors <ashors@nvidia.com> Date: Thu Aug 7 13:11:43 2025 -0700 feat: support DTensor CP in DPO and SFT (NVIDIA-NeMo#798) Signed-off-by: ashors1 <ashors@nvidia.com> commit 0988a7d Author: Felipe Vieira Frujeri <ffrujeri@gmail.com> Date: Wed Aug 6 22:01:32 2025 -0700 fix: Fix error message in VllmGenerationWorker. (NVIDIA-NeMo#633) Signed-off-by: Felipe Vieira Frujeri <ffrujeri@nvidia.com> commit 233cc07 Author: Parth Chadha <pchadha@nvidia.com> Date: Wed Aug 6 15:14:22 2025 -0700 fix: force use of eager (disabled cuda graphs) due to convergence issues (NVIDIA-NeMo#857) Signed-off-by: Parth Chadha <pchadha@nvidia.com> commit 0557402 Author: Terry Kong <terrycurtiskong@gmail.com> Date: Wed Aug 6 14:44:29 2025 -0700 chore: 0.3.0 -> 0.4.0rc0 (NVIDIA-NeMo#840) Signed-off-by: Terry Kong <terryk@nvidia.com> commit 03472a0 Author: Terry Kong <terrycurtiskong@gmail.com> Date: Wed Aug 6 14:43:55 2025 -0700 feat: dockerfile can build hermetically or from build context (NVIDIA-NeMo#799) Signed-off-by: Terry Kong <terryk@nvidia.com> commit 9af0a52 Author: Anna Shors <ashors@nvidia.com> Date: Wed Aug 6 12:35:51 2025 -0700 fix: fix grpo + mcore checkpointing without validation (NVIDIA-NeMo#844) Signed-off-by: ashors1 <ashors@nvidia.com> commit b6269f7 Author: Yubo Gao <yubog@nvidia.com> Date: Tue Aug 5 16:55:02 2025 -0400 feat: track policy training compute throughput (NVIDIA-NeMo#632) Signed-off-by: Yubo Gao <yubog@nvidia.com> commit b74c5d0 Author: Wei Du <wedu@nvidia.com> Date: Tue Aug 5 15:05:13 2025 -0500 feat: save checkpoint before timeout to avoid 4-hour runtime limit (NVIDIA-NeMo#734) Signed-off-by: Wei Du <wedu@nvidia.com> Signed-off-by: Terry Kong <terrycurtiskong@gmail.com> Co-authored-by: Terry Kong <terrycurtiskong@gmail.com> commit c784dd9 Author: Zhiyu Li <zhiyul@NVIDIA.com> Date: Tue Aug 5 10:47:30 2025 -0700 feat: add data shuffle and random seed option (NVIDIA-NeMo#334) Signed-off-by: Zhiyu Li <zhiyul@nvidia.com> Signed-off-by: Zhiyu Li <zhiyul@NVIDIA.com> commit c249efc Author: Abdalgader Abubaker <136640907+abdalgader-a@users.noreply.github.com> Date: Tue Aug 5 21:33:28 2025 +0400 docs: fix checkpointing command for megatron->hf export (NVIDIA-NeMo#823) Signed-off-by: abdalgader-a <abdalgader.abubaker@tii.ae> Signed-off-by: Youngeun Kwon <youngeunk@nvidia.com>

Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca> Signed-off-by: Julien Veron Vialard <jveronvialar@nvidia.com>

Update README.md

b6fe58a

Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca>

wangshangsam requested a review from terrykong August 5, 2025 02:30

wangshangsam had a problem deploying to nemo-ci August 5, 2025 02:30 — with GitHub Actions Error

Merge branch 'main' into wangshangsam/uv-install-instructions

4525c3e

wangshangsam temporarily deployed to nemo-ci August 5, 2025 02:32 — with GitHub Actions Inactive

wangshangsam temporarily deployed to nemo-ci August 5, 2025 03:13 — with GitHub Actions Inactive

terrykong reviewed Aug 5, 2025

View reviewed changes

wangshangsam mentioned this pull request Aug 8, 2025

Replace relative source links with github links #577

Open

Add a helper function in conf.py to properly render GH alerts in MyST…

1cdffcb

…-Parser. Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca>

github-actions bot added the documentation Improvements or additions to documentation label Aug 8, 2025

Merge branch 'main' into wangshangsam/uv-install-instructions

87107b3

wangshangsam requested a review from terrykong August 8, 2025 15:35

terrykong enabled auto-merge August 8, 2025 16:15

terrykong approved these changes Aug 8, 2025

View reviewed changes

terrykong added this pull request to the merge queue Aug 8, 2025

Merged via the queue into main with commit e924d33 Aug 8, 2025
19 checks passed

terrykong deleted the wangshangsam/uv-install-instructions branch August 8, 2025 19:59

soodoshll pushed a commit to soodoshll/RL that referenced this pull request Aug 13, 2025

docs: Link uv's installation instructions to uv's website (NVIDIA-NeM…

6e71178

…o#837) Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca> Signed-off-by: Qidong Su <qidongs@nvidia.com>

jveronvialard pushed a commit that referenced this pull request Aug 27, 2025

docs: Link uv's installation instructions to uv's website (#837)

dfeaa7c

Signed-off-by: Shang Wang <samshang.wang@mail.utoronto.ca> Signed-off-by: Julien Veron Vialard <jveronvialar@nvidia.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: Link uv's installation instructions to uv's website #837

docs: Link uv's installation instructions to uv's website #837

Uh oh!

wangshangsam commented Aug 5, 2025 •

edited

Loading

Uh oh!

terrykong left a comment

Uh oh!

wangshangsam commented Aug 6, 2025

Uh oh!

wangshangsam commented Aug 7, 2025

Uh oh!

terrykong commented Aug 7, 2025

Uh oh!

Uh oh!

Uh oh!

docs: Link uv's installation instructions to uv's website #837

docs: Link uv's installation instructions to uv's website #837

Uh oh!

Conversation

wangshangsam commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do ?

Issues

Usage

Before your PR is "Ready for review"

Additional Information

Uh oh!

terrykong left a comment

Choose a reason for hiding this comment

Uh oh!

wangshangsam commented Aug 6, 2025

Uh oh!

wangshangsam commented Aug 7, 2025

Uh oh!

terrykong commented Aug 7, 2025

Uh oh!

Uh oh!

Uh oh!

wangshangsam commented Aug 5, 2025 •

edited

Loading