Skip to content

Conversation

@whoisj
Copy link
Contributor

@whoisj whoisj commented Oct 8, 2025

Update the README file to remove the "experimental" tag from the documentation.

The existence of the tag was an oversight as Torch 2.x has been supported for 18+ months at this point.

TRI-53

@whoisj whoisj added the documentation Improvements or additions to documentation label Oct 8, 2025
@whoisj whoisj requested a review from yinggeh October 8, 2025 20:02
@yinggeh
Copy link
Contributor

yinggeh commented Oct 9, 2025

Nice work! I can see you are updating doc to reflect PyTorch2 as well as improving the readability. However it's a challenge to review in one place. Could you make it a separate PR for the refactor? Thx


# PyTorch (LibTorch) Backend

[![License](https://img.shields.io/badge/License-BSD3-lightgrey.svg)](https://opensource.org/licenses/BSD-3-Clause)
Copy link
Contributor

Choose a reason for hiding this comment

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

What's the implication of moving License position?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Having content before the H1 header is considered "bad form" for markdown documents.

@whoisj whoisj force-pushed the jwyman/update-pyt-docs branch from c862048 to 5e6c447 Compare October 9, 2025 17:31
@whoisj whoisj requested a review from yinggeh October 9, 2025 17:32
@whoisj whoisj force-pushed the jwyman/update-pyt-docs branch from 5e6c447 to da24e73 Compare October 9, 2025 17:37
README.md Outdated
```

## Limitations
### Limitations
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should

  1. merge "Limitations" into "Important Notes" section.
  2. merge "PyTorch 2.0" into "Using the PyTorch Backend" section
    What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done.

Update the README file to remove the "experimental" tag from the documentaion.

The existance of the tag was an oversight as Torch 2.x has been supported for 18+ months at this point.

Signed-off-by: J Wyman <jwyman@nvidia.com>
@whoisj whoisj force-pushed the jwyman/update-pyt-docs branch from da24e73 to fbf4be1 Compare October 9, 2025 19:06
@whoisj whoisj requested a review from yinggeh October 9, 2025 19:07
Copy link
Contributor

@yinggeh yinggeh left a comment

Choose a reason for hiding this comment

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

LGTM

@whoisj whoisj merged commit abafeb6 into main Oct 9, 2025
1 check passed
@yinggeh
Copy link
Contributor

yinggeh commented Oct 9, 2025

@whoisj Please also update the description to reflect the changes in this PR

@yinggeh
Copy link
Contributor

yinggeh commented Oct 10, 2025

@whoisj Please also update the description to reflect the changes in this PR

^ @whoisj

@whoisj
Copy link
Contributor Author

whoisj commented Oct 10, 2025

@whoisj Please also update the description to reflect the changes in this PR

^ @whoisj

Done. Sorry I missed the original request.

@whoisj whoisj deleted the jwyman/update-pyt-docs branch October 10, 2025 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Development

Successfully merging this pull request may close these issues.

2 participants