[OpenReg] Add Develop Notes for Integrating New Backend into PyTorch by fffrog · Pull Request #158644 · pytorch/pytorch

fffrog · 2025-07-18T12:22:06Z

Stack from ghstack (oldest at bottom):

To facilitate the integration of the new backend, we plan to publish a new development note that details all the key components,hoping to speed up the development of other accelerators.

This PR is the beginning of this note, and involve the part of registration of operators and we will gradually improve it and keep in sync with OpenReg's code.

[ghstack-poisoned]

pytorch-bot · 2025-07-18T12:22:10Z

🔗 Helpful Links

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

📄 Preview Python docs built from this PR
📄 Preview C++ docs built from this PR
❓ Need help or want to give feedback on the CI? Visit the bot commands wiki or our office hours

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

❌ 1 New Failure, 1 Unrelated Failure

As of commit 0d85743 with merge base 9a12bab ():

NEW FAILURE - The following job has failed:

trunk / linux-jammy-rocm-py3.10 / test (default, 2, 2, linux.rocm.gpu.gfx942.1) (gh)
test_cuda.py::TestCudaMallocAsync::test_allocator_settings

FLAKY - The following job failed but was likely due to flakiness present on trunk:

trunk / macos-py3-arm64 / test (default, 2, 3, macos-m1-stable) (gh) (similar failure)
Build left local git repository checkout dirty

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

As the title stated. To facilitate the integration of the new backend, we plan to publish a new development note that details all the key components, hoping to speed up the development of other accelerators. This PR is the beginning of this note, which we will gradually improve and keep in sync with OpenReg's code. ghstack-source-id: 6b8c629 Pull-Request-resolved: #158644

[ghstack-poisoned]

As the title stated. To facilitate the integration of the new backend, we plan to publish a new development note that details all the key components, hoping to speed up the development of other accelerators. This PR is the beginning of this note, which we will gradually improve and keep in sync with OpenReg's code. ghstack-source-id: 7986da4 Pull-Request-resolved: #158644

albanD

Thanks for starting this!
I'm sure there is going to be a LOT of things to add there. But very exciting to see this first draft!

docs/source/conf.py

docs/source/notes/accelerator.md

[ghstack-poisoned]

As the title stated. To facilitate the integration of the new backend, we plan to publish a new development note that details all the key components, hoping to speed up the development of other accelerators. This PR is the beginning of this note, which we will gradually improve and keep in sync with OpenReg's code. ghstack-source-id: 9c3aee3 Pull-Request-resolved: #158644

[ghstack-poisoned]

As the title stated. To facilitate the integration of the new backend, we plan to publish a new development note that details all the key components, hoping to speed up the development of other accelerators. This PR is the beginning of this note, which we will gradually improve and keep in sync with OpenReg's code. ghstack-source-id: 9ea01fc Pull-Request-resolved: #158644

[ghstack-poisoned]

As the title stated. To facilitate the integration of the new backend, we plan to publish a new development note that details all the key components, hoping to speed up the development of other accelerators. This PR is the beginning of this note, which we will gradually improve and keep in sync with OpenReg's code. ghstack-source-id: 2e10e33 Pull-Request-resolved: #158644

[ghstack-poisoned]

As the title stated. To facilitate the integration of the new backend, we plan to publish a new development note that details all the key components, hoping to speed up the development of other accelerators. This PR is the beginning of this note, which we will gradually improve and keep in sync with OpenReg's code. ghstack-source-id: 275a5c1 Pull-Request-resolved: #158644

[ghstack-poisoned]

To facilitate the integration of the new backend, we plan to publish a new development note that details all the key components,hoping to speed up the development of other accelerators. This PR is the beginning of this note, and involve the part of registration of operators and we will gradually improve it and keep in sync with OpenReg's code. ghstack-source-id: 29c7776 Pull-Request-resolved: pytorch#158644

[ghstack-poisoned]

To facilitate the integration of the new backend, we plan to publish a new development note that details all the key components,hoping to speed up the development of other accelerators. This PR is the beginning of this note, and involve the part of registration of operators and we will gradually improve it and keep in sync with OpenReg's code. ghstack-source-id: 915366b Pull-Request-resolved: pytorch#158644

[ghstack-poisoned]

albanD

Looks great!
Thanks for the time and effort in compiling all of this.

As this document grows we might want to have a shorter intro at the top about the big axis: c++ scaffolding, operators, testing, python module.
Also mentioning for the future that in the latest branch, we started a user guide section in the doc that might be a good place if we want to have multiple pages nicely tied together: https://docs.pytorch.org/docs/main/user_guide/index.html

All the comments are pretty minor, please add the appropriate external link and then you can merge!

docs/source/notes/extending_accelerator.md

[ghstack-poisoned]

fffrog · 2025-08-27T10:13:52Z

As this document grows we might want to have a shorter intro at the top about the big axis: c++ scaffolding, operators, testing, python module.

Got it, I will add it in the follow-up PRs.

Also mentioning for the future that in the latest branch, we started a user guide section in the doc that might be a good place if we want to have multiple pages nicely tied together: https://docs.pytorch.org/docs/main/user_guide/index.html

Thank you very much for these very helpful suggestions.
As the documentation expands, it will contain more and more information. If we can split it into several separate files, it will not only be easier for users to read but also for developers to maintain.

So, is it possible to create a separate section within the User Guide (on the same level as the Developer Notes) and then split the documentation into sections with granularity like Overall, Operators, Runtime and so on? This might provide more clarity.

fffrog · 2025-08-27T10:15:00Z

@pytorchbot merge

pytorchmergebot · 2025-08-27T10:18:11Z

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

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 · 2025-08-27T11:00:47Z

Merge failed

Reason: 1 jobs have failed, first few of them are: trunk / linux-jammy-rocm-py3.10 / test (default, 2, 2, linux.rocm.gpu.gfx942.1)

Details for Dev Infra team

Raised by workflow job

fffrog · 2025-08-27T14:38:52Z

@pytorchbot merge -i

pytorchmergebot · 2025-08-27T14:41:00Z

Merge started

Your change will be merged while ignoring the following 2 checks: trunk / macos-py3-arm64 / test (default, 2, 3, macos-m1-stable), trunk / linux-jammy-rocm-py3.10 / test (default, 2, 2, linux.rocm.gpu.gfx942.1)

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

…61603) As the title stated. Related Infos: #158644 (comment) Pull Request resolved: #161603 Approved by: https://github.com/albanD

…ytorch#158644) To facilitate the integration of the new backend, we plan to publish a new development note that details all the key components,hoping to speed up the development of other accelerators. This PR is the beginning of this note, and involve the part of registration of operators and we will gradually improve it and keep in sync with OpenReg's code. Pull Request resolved: pytorch#158644 Approved by: https://github.com/albanD

…torch#161603) As the title stated. Related Infos: pytorch#158644 (comment) Pull Request resolved: pytorch#161603 Approved by: https://github.com/albanD

Update

ae2d8f4

[ghstack-poisoned]

fffrog requested review from albanD and jeffdaily as code owners July 18, 2025 12:22

pytorch-bot bot added the release notes: releng release notes category label Jul 18, 2025

This was referenced Jul 18, 2025

[OpenReg] Improve README.md and optimize some codes for OpenReg #158415

Closed

[OpenReg] add pyproject.toml for openreg #158440

Closed

[OpenReg] move fallback tests into test_openreg.py #158441

Closed

pytorchbot added the open source label Jul 18, 2025

Update

cb7c6e6

[ghstack-poisoned]

albanD reviewed Jul 18, 2025

View reviewed changes

janeyx99 reviewed Jul 18, 2025

View reviewed changes

docs/source/notes/accelerator.md Outdated Show resolved Hide resolved

Update

364df96

[ghstack-poisoned]

fffrog marked this pull request as draft July 21, 2025 08:05

Update

d12bff1

[ghstack-poisoned]

fffrog mentioned this pull request Jul 23, 2025

[Feat] Tracking for OpenReg Improvements #158917

Open

38 tasks

Update

103288c

[ghstack-poisoned]

Update

3cab36b

[ghstack-poisoned]

pytorch-bot bot added the topic: not user facing topic category label Aug 1, 2025

This was referenced Aug 1, 2025

Moved Autograd Fallback Interface to Header for Use by Out-of-tree Backends #159639

Closed

[OpenReg] Refactor and Optimize the OpenReg for Preparation of Docs #159640

Closed

fffrog marked this pull request as ready for review August 1, 2025 09:14

fffrog changed the title ~~[OpenReg] Add Develop Notes for Integrating New Backend into PyTorch~~ [OpenReg] Add Develop Notes for Integrating New Backend into PyTorch(Operator Aspect) Aug 1, 2025

Update

a0fed8d

[ghstack-poisoned]

Update

58d9fe1

[ghstack-poisoned]

fffrog added 2 commits August 19, 2025 16:45

Update

2506ff2

[ghstack-poisoned]

Update

26e3beb

[ghstack-poisoned]

Update

3509b3a

[ghstack-poisoned]

albanD approved these changes Aug 26, 2025

View reviewed changes

Update

2e8e565

[ghstack-poisoned]

fffrog mentioned this pull request Aug 27, 2025

[OpenReg] Rename cpu_fallback_blacklist to cpu_fallback_blocklist #161603

Closed

Update

0d85743

[ghstack-poisoned]

pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label Aug 27, 2025

pytorchmergebot added the merging label Aug 27, 2025

pytorchmergebot removed the merging label Aug 27, 2025

pytorchmergebot added the merging label Aug 27, 2025

pytorchmergebot closed this in d2db6c8 Aug 27, 2025

pytorchmergebot added Merged and removed merging labels Aug 27, 2025

pytorchmergebot pushed a commit that referenced this pull request Aug 30, 2025

[OpenReg] Rename cpu_fallback_blacklist to cpu_fallback_blocklist (#1…

dad2e50

…61603) As the title stated. Related Infos: #158644 (comment) Pull Request resolved: #161603 Approved by: https://github.com/albanD

github-actions bot deleted the gh/fffrog/124/head branch September 27, 2025 02:07

mansiag05 mentioned this pull request Jan 13, 2026

[OpenReg] Add documentation for standardized testing patterns. #172324

Open

6 tasks

Conversation

fffrog commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pytorch-bot bot commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

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

❌ 1 New Failure, 1 Unrelated Failure

Uh oh!

albanD left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

albanD left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fffrog commented Aug 27, 2025

Uh oh!

fffrog commented Aug 27, 2025

Uh oh!

pytorchmergebot commented Aug 27, 2025

Merge started

Uh oh!

pytorchmergebot commented Aug 27, 2025

Merge failed

Uh oh!

fffrog commented Aug 27, 2025

Uh oh!

pytorchmergebot commented Aug 27, 2025

Merge started

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

fffrog commented Jul 18, 2025 •

edited

Loading

pytorch-bot bot commented Jul 18, 2025 •

edited

Loading