Skip to content

[privateuse1] Update tutorial to document Python backend approach#3842

Open
RiyaP2508 wants to merge 2 commits intopytorch:mainfrom
RiyaP2508:update-privateuseone-python-backend
Open

[privateuse1] Update tutorial to document Python backend approach#3842
RiyaP2508 wants to merge 2 commits intopytorch:mainfrom
RiyaP2508:update-privateuseone-python-backend

Conversation

@RiyaP2508
Copy link
Copy Markdown

@RiyaP2508 RiyaP2508 commented Apr 28, 2026 •
edited by pytorch-bot Bot
Loading

Summary

  • Added "Python Backend Approach (Simplified)" section documenting
    _setup_privateuseone_for_python_backend() from Add functions to setup PrivateUse1 as a python backend device. pytorch#157859
  • Complete end-to-end NumPy-backed example with autograd (11 registered ops)
  • Hooks/device guard customization with backward() failure warning
  • Added hooks registration warning to existing C++ section
  • C++ vs Python comparison table and limitations
  • Cross-references to torch_openreg and test files

Fixes pytorch/pytorch#179010
Fixes pytorch/pytorch#179008

Test plan

  • make html-noplot builds without RST warnings
  • New sections render correctly in docs preview
  • Code examples validated against PyTorch nightly

cc @albanD @jbschlosser @kshitij12345 @qihqi @fffrog

@RiyaP2508
Update PrivateUse1 tutorial to document Python backend approach
d42b750 
Add new section covering _setup_privateuseone_for_python_backend() with
tensor subclass pattern, torch.library op registration, hooks/device guard
customization, end-to-end NumPy-backed example, comparison table, and
limitations. Also add hooks registration warning to existing C++ section.

Fixes pytorch/pytorch#179010
Fixes pytorch/pytorch#179008
@pytorch-bot
Copy link
Copy Markdown

pytorch-bot Bot commented Apr 28, 2026 •
edited
Loading

🔗 Helpful Links

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

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

❗ 1 Active SEVs

There are 1 currently active SEVs. If your PR is affected, please view them below:

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

@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented Apr 28, 2026

Hi @RiyaP2508!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@svekars svekars added C++ Issues relating to C++ tutorials core Tutorials of any level of difficulty related to the core pytorch functionality labels Apr 28, 2026
@meta-cla meta-cla Bot added the cla signed label Apr 28, 2026
@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented Apr 28, 2026

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

C++ Issues relating to C++ tutorials cla signed core Tutorials of any level of difficulty related to the core pytorch functionality

Projects

None yet

Milestone

No milestone

2 participants

@RiyaP2508 @svekars