Skip to content

fix(readme): update broken links and modernize project description#2879

Open
sbhavani wants to merge 3 commits intoNVIDIA:mainfrom
sbhavani:fix/readme-updates-v2
Open

fix(readme): update broken links and modernize project description#2879
sbhavani wants to merge 3 commits intoNVIDIA:mainfrom
sbhavani:fix/readme-updates-v2

Conversation

@sbhavani
Copy link
Copy Markdown
Collaborator

Description

Update README to fix broken links and update description

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

Please list the changes introduced in this PR:

  • Fix broken getting_started.html link (404) → index.html
  • Update redirected URLs: lambdalabs.comlambda.ai, mosaicml.comdatabricks.com
  • Modernize "What is Transformer Engine?" to reference current model architectures (LLMs, MoE, multimodal) instead of dated examples (BERT, GPT, T5)
  • Reframe TE value proposition around optimizations for advanced features (MoE, parallelism, fused ops) with low precision

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

Signed-off-by: Santosh Bhavani <santosh.bhavani@live.com>
Signed-off-by: Santosh Bhavani <santosh.bhavani@live.com>
@sbhavani sbhavani force-pushed the fix/readme-updates-v2 branch from c7461cb to 65374d9 Compare April 14, 2026 14:44
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 14, 2026

Greptile Summary

This PR updates README.rst to fix a broken documentation link, modernize the "What is Transformer Engine?" description to reference LLMs/MoE/multimodal architectures, and redirect stale external URLs (lambdalabs.comlambda.ai, mosaicml.comdatabricks.com). However, the link-fix introduced a duplicate "Getting Started Guide" sentence (lines 140–141) — the original single line was replaced by two lines pointing to different URLs — and the blank line separating the Flax code block from that paragraph was also removed.

Confidence Score: 4/5

  • The PR is close to merge-ready but has one P1 defect — a duplicate sentence that will visibly render in the published README.
  • All URL and description changes are correct and well-motivated. The single blocking issue is the duplicate "Getting Started Guide" line (140–141) introduced when the old broken link was replaced by two competing lines instead of one.
  • README.rst lines 140–141 — the duplicate sentence must be resolved before merging.

Important Files Changed

Filename Overview
README.rst Documentation update fixing broken links and modernizing description, but introduces a duplicate "Getting Started Guide" sentence and drops the blank line separating the code block from the following paragraph.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README.rst changes] --> B[Description modernized\nLLMs / MoE / multimodal]
    A --> C[External URL redirects]
    A --> D[Getting Started link fix]
    C --> C1[lambdalabs.com → lambda.ai]
    C --> C2[mosaicml.com → databricks.com\ntable + Previous News]
    D --> D1["getting_started/index.html ✅"]
    D --> D2["index.html ❌ duplicate line"]
Loading

Reviews (2): Last reviewed commit: "Update README.rst" | Re-trigger Greptile

Comment thread README.rst Outdated
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Signed-off-by: Santosh Bhavani <santosh.bhavani@live.com>
@sbhavani sbhavani requested a review from ksivaman April 14, 2026 16:32
Comment thread README.rst
Comment on lines +140 to +141
For a more comprehensive tutorial, check out our `Getting Started Guide <https://docs.nvidia.com/deeplearning/transformer-engine/user-guide/getting_started/index.html>`_.
For a more comprehensive tutorial, check out our `Getting Started Guide <https://docs.nvidia.com/deeplearning/transformer-engine/user-guide/index.html>`_.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Duplicate line.

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