Skip to content

[ONNX] Update onnx.md to simplify deprecated entities #159312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 4 commits into from
Closed

[ONNX] Update onnx.md to simplify deprecated entities #159312

wants to merge 4 commits into from
+15 −21

Conversation

justinchuby
Copy link
Collaborator

Simplify documentation of deprecated entities and remove the auto-generated page for JitScalarType

@justinchuby
[ONNX] onnx.md to simplify deprecated entities
141eabb 
Simplify documentation of deprecated entities and remove the auto-generated page for JitScalarType
@pytorch-bot pytorch-bot bot added the topic: not user facing topic category label Jul 28, 2025
@pytorch-bot PyTorch Bot
Copy link

pytorch-bot bot commented Jul 28, 2025 •
edited
Loading

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/159312

Note: Links to docs will display an error until the docs builds have been completed.

✅ You can merge normally! (1 Unrelated Failure)

As of commit fbe9b63 with merge base 59e261b (image):

UNSTABLE - The following job is marked as unstable, possibly due to flakiness on trunk:

This comment was automatically generated by Dr. CI and updates every 15 minutes.

Copilot
Copilot AI reviewed Jul 28, 2025
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR simplifies the documentation structure for deprecated ONNX entities by removing auto-generated documentation and streamlining the layout. The changes focus on making the deprecated API section more concise while maintaining necessary documentation.

  • Moved the hidden toctree to the top of the file for better organization
  • Simplified JitScalarType documentation from auto-generated summary to direct autoclass
  • Removed unnecessary comments and cleaned up the documentation structure

@justinchuby justinchuby added module: onnx Related to torch.onnx topic: docs topic category release notes: onnx torch.onnx related changes that should show up in the release notes and removed topic: not user facing topic category labels Jul 28, 2025
@justinchuby
Copy link
Collaborator Author

@pytorchbot merge -i

@pytorch-bot pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label Jul 29, 2025
@justinchuby
Copy link
Collaborator Author

@pytorchbot merge -i

@pytorchmergebot
Copy link
Collaborator

Merge started

Your change will be merged while ignoring the following 3 checks: pull / linux-jammy-cpu-py3.10-gcc11-bazel-test / build-and-test (default, 1, 1, linux.4xlarge), pull / linux-jammy-py3_9-clang9-xla / test (xla, 1, 1, linux.12xlarge, unstable), trunk / macos-py3-arm64 / build

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging
Check the merge workflow status
here

@pytorchmergebot
Copy link
Collaborator

The merge job was canceled or timed out. This most often happen if two merge requests were issued for the same PR, or if merge job was waiting for more than 6 hours for tests to finish. In later case, please do not hesitate to reissue the merge command
For more information see pytorch-bot wiki.

@pytorch-bot pytorch-bot bot added the topic: not user facing topic category label Jul 29, 2025
justinchuby
justinchuby commented Jul 29, 2025
View reviewed changes
@justinchuby
Copy link
Collaborator Author

@pytorchbot merge -i

@pytorchmergebot
Copy link
Collaborator

Merge started

Your change will be merged while ignoring the following 1 checks: pull / linux-jammy-py3_9-clang9-xla / test (xla, 1, 1, linux.12xlarge, unstable)

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging
Check the merge workflow status
here

@justinchuby justinchuby changed the title [ONNX] onnx.md to simplify deprecated entities [ONNX] Update onnx.md to simplify deprecated entities Jul 29, 2025
yangw-dev pushed a commit that referenced this pull request Aug 1, 2025
@justinchuby @yangw-dev
[ONNX] onnx.md to simplify deprecated entities (#159312)
85aac5f 
Simplify documentation of deprecated entities and remove the auto-generated page for JitScalarType
Pull Request resolved: #159312
Approved by: https://github.com/titaiwangms
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@titaiwangms titaiwangms titaiwangms approved these changes

Assignees
No one assigned
Labels
ciflow/trunk Trigger trunk jobs on your pull request Merged module: onnx Related to torch.onnx open source release notes: onnx torch.onnx related changes that should show up in the release notes topic: docs topic category topic: not user facing topic category
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@justinchuby @pytorchmergebot @titaiwangms @pytorchbot