Skip to content

docs: add "What's Hot" section to README#1992

Open
lbliii wants to merge 2 commits into
NVIDIA-NeMo:mainfrom
lbliii:lbliii/readme-whats-new-section
Open

docs: add "What's Hot" section to README#1992
lbliii wants to merge 2 commits into
NVIDIA-NeMo:mainfrom
lbliii:lbliii/readme-whats-new-section

Conversation

@lbliii

@lbliii lbliii commented May 15, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds a "What's Hot" section to the top of the README highlighting Slurm deployment, Audio curation, and the Inference Server
  • Sits above the existing "Updates" release log so feature highlights and release history serve distinct purposes
  • Addresses #1552 (better surfacing of new features on the landing page)

Context

Requested by Arham in #docs Slack thread — developers landing on the README should immediately see the latest capabilities worth trying. The three highlighted features were called out by Arham; cc @nemo-curator-leads if anything else should be added before merge (candidates: Cosmos-Embed1 video embeddings, Nemotron-CC recipe, simplified Resources API).

Test plan

  • Preview README rendering on GitHub
  • Verify all three doc links resolve
  • Confirm leads are aligned on the three highlighted features

🤖 Generated with Claude Code

@lbliii lbliii requested a review from a team as a code owner May 15, 2026 17:52
@lbliii lbliii requested review from VibhuJawa and removed request for a team May 15, 2026 17:52
@copy-pr-bot

copy-pr-bot Bot commented May 15, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@greptile-apps

greptile-apps Bot commented May 15, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds a "What's Hot" section to the top of README.md, surfacing three key capabilities — Slurm deployment, Audio curation, and the Inference Server — with a Markdown table linking to their respective docs pages.

  • A new ## What's Hot section with a three-row feature table is inserted between the NeMo suite tagline and the existing ## Updates release log.
  • A blockquote callout invites contributors to suggest additional features via an issue or team mention.

Confidence Score: 5/5

Documentation-only change with no code modifications; safe to merge once the three linked doc URLs are manually confirmed to resolve.

The change is limited to inserting a Markdown table and blockquote in README.md. No logic, configuration, or runtime behaviour is affected. The only open question is whether the three external documentation URLs resolve correctly, which the PR's own test plan flags as an outstanding check.

No files require special attention beyond confirming the three external doc links are live before merge.

Important Files Changed

Filename Overview
README.md Adds a 'What's Hot' table section above the existing Updates log, linking to Slurm deployment, Audio curation, and Inference Server docs; no structural issues found.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README.md] --> B[Badges & Header]
    B --> C[NeMo suite tagline]
    C --> D["## What's Hot (NEW)"]
    D --> D1["Curator on Slurm → Slurm Deployment Guide"]
    D --> D2["Audio Curation → Audio Guide"]
    D --> D3["Inference Server → Inference Server docs"]
    D --> E["## Updates (release log)"]
    E --> F["## What You Can Build"]
    F --> G[Rest of README...]
Loading

Reviews (3): Last reviewed commit: "Merge branch 'main' into lbliii/readme-w..." | Re-trigger Greptile

@lbliii lbliii requested a review from arhamm1 May 15, 2026 18:17
Surfaces the latest capabilities developers should know about — Slurm,
Audio, and Inference Server — at the top of the README. Addresses NVIDIA-NeMo#1552.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Signed-off-by: Lawrence Lane <llane@nvidia.com>
@lbliii lbliii force-pushed the lbliii/readme-whats-new-section branch from b03bfbd to 32f6c6b Compare May 15, 2026 19:03
@lbliii lbliii self-assigned this May 27, 2026
Comment thread README.md

| Feature | What it unlocks | Read this |
|---------|-----------------|-----------|
| **Curator on Slurm** | Run multi-node Ray pipelines on HPC clusters — text, image, video, and audio workloads at scale | [Slurm Deployment Guide](https://docs.nvidia.com/nemo/curator/latest/admin/deployment/slurm/multi-node-ray.html) |

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.

This link is broken for me.

Comment thread README.md
| Feature | What it unlocks | Read this |
|---------|-----------------|-----------|
| **Curator on Slurm** | Run multi-node Ray pipelines on HPC clusters — text, image, video, and audio workloads at scale | [Slurm Deployment Guide](https://docs.nvidia.com/nemo/curator/latest/admin/deployment/slurm/multi-node-ray.html) |
| **Audio Curation** | Curate speech datasets for ASR and multimodal training — transcription, WER filtering, and quality assessment | [Audio Guide](https://docs.nvidia.com/nemo/curator/latest/curate-audio/index.html) |

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.

Agree that we should list audio curation but not sure this is the best description since transcription, WER filtering, and quality assessment were the first things added to audio. Since then several other pipelines have been added: https://github.com/NVIDIA-NeMo/Curator/commits/main/nemo_curator/stages/audio

Maybe most notably, ALM (Audio Language Model) data curation, quality filtering via AudioDataFilterStage, and audio tagging and speaker diarization. (Claude can probably summarize these concepts better than me.)

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