docs: Improve README #161
Open
docs: Improve README #161
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
whoisj
force-pushed
the
jwyman/update-pyt-docs
branch
from
da24e73 to
fbf4be1
Compare
whoisj
force-pushed
the
jwyman/improve-readme
branch
from
33b5537 to
987cf37
Compare
|
You may rebase to main now. |
yinggeh
reviewed
Oct 10, 2025
yinggeh
previously approved these changes
Oct 10, 2025
yinggeh
reviewed
Oct 10, 2025
yinggeh
previously approved these changes
Oct 10, 2025
Update the README file to improve readability, clarity, and markdown formatting standards. Cleaned up and improvements were applied to the document: - Correctly indented content within bullet-point lists. - Used GitHub flavored markdown to enable NOTE, TIP, etc. callouts where appropriate. - Reflowed text to use the more standard new-line after every sentance style. - Replaced works this "this", "here", and "link" with more descriptive terms for link text. - Corrected the format of the pbtxt examples. - Updated the recommended pytorch container from NGC.
Use yaml instead of proto for code blocks to improve readability. Add example instance_group configuration.
whoisj
force-pushed
the
jwyman/improve-readme
branch
from
3877988 to
d183441
Compare
|
@yinggeh sorry to ask again, but I had to rebase the change to handle the conflict and lost your previous approval in doing so. |
Please do not force push. Reviews will lose their last reviewed commit and have no idea what's been changed since last review |
yinggeh
approved these changes
Oct 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the README file to improve readability, clarity, and markdown formatting standards.
Cleaned up and improvements were applied to the document: