Skip to content

Conversation

@sbhavani
Copy link
Collaborator

@sbhavani sbhavani commented Feb 1, 2026

Description

Updates README add missing format support documentation, update news section, and fix broken/outdated links.

Type of change

  • Documentation change (change only to the documentation, either a fix or a new content)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Infra/Build change
  • Code refactoring

Changes

  • Add MXFP8 and NVFP4 format support to highlights and description
  • Update FP8 convergence table with MXFP8 results from arxiv paper
  • Remove outdated JAX Toolbox links and "available on request" entries
  • Update Docker container versions to 26.01
  • Fix DeepSpeed and Lightning integration links
  • Add Nemotron 3 paper to Latest News
  • Add quickstart notebook link after PyTorch example

Checklist:

  • I have read and followed the contributing guidelines
  • The functionality is complete
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

…t info

- Add MXFP8 and NVFP4 format support to highlights and description
- Update FP8 convergence table with MXFP8 results from arxiv paper
- Remove outdated JAX-Toolbox links and "available on request" entries
- Update Docker container versions to 26.01
- Fix DeepSpeed and Lightning integration links
- Add Nemotron 3 paper to Latest News
- Add quickstart notebook link after PyTorch example
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 1, 2026

Greptile Overview

Greptile Summary

This PR updates the README with several documentation improvements, primarily focused on new format support and keeping information current.

Key changes:

  • Added MXFP8 and NVFP4 format support documentation to highlights and description sections
  • Updated FP8 convergence table with new Megatron Core results (LLM-8B, MoE-16B)
  • Removed outdated "Available on request" entries and JAX Toolbox specific model entries from convergence table
  • Updated Docker container versions from 25.08 to 26.01
  • Fixed integration links for DeepSpeed and Lightning
  • Added Nemotron 3 paper to Latest News section
  • Removed "Coming soon!" status from several integrations

Issue found:

  • The newly added quickstart notebook link (line 97) references a non-existent file docs/examples/quickstart.ipynb

Confidence Score: 4/5

  • This PR is mostly safe to merge after fixing the broken notebook link
  • The changes are documentation-only and improve accuracy by updating outdated information. However, the score is 4 instead of 5 because one of the newly added links references a non-existent file, which would result in a 404 error for users
  • README.rst line 97 needs attention - the quickstart notebook link must be fixed before merging

Important Files Changed

Filename Overview
README.rst Documentation updates including MXFP8/NVFP4 support, convergence table updates, Docker version updates, and link fixes; one broken notebook link found

Sequence Diagram

sequenceDiagram
    participant Author as PR Author
    participant README as README.rst
    participant User as Documentation Reader
    
    Author->>README: Add MXFP8/NVFP4 format support info
    Author->>README: Update FP8 convergence table
    Author->>README: Remove outdated JAX Toolbox entries
    Author->>README: Update Docker versions (25.08 → 26.01)
    Author->>README: Fix DeepSpeed & Lightning links
    Author->>README: Add Nemotron 3 paper to Latest News
    Author->>README: Add quickstart notebook link (line 97)
    
    Note over README: ⚠️ quickstart.ipynb does not exist
    
    User->>README: Click quickstart notebook link
    README-->>User: 404 Not Found Error
    
    Note over Author,User: Fix required: Create notebook or update link
Loading

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

loss = out.sum()
loss.backward()

For a tutorial with more details, see the `Quickstart Notebook <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/examples/quickstart.ipynb>`_.
Copy link
Contributor

Choose a reason for hiding this comment

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

The referenced quickstart.ipynb file does not exist in docs/examples/. The actual notebooks in that directory are fp8_primer.ipynb, advanced_optimizations.ipynb, and te_jax_integration.ipynb. Consider using one of these existing notebooks or creating the quickstart notebook before merging.

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.

1 participant