pytorch / tutorials

PyTorch tutorials.

https://pytorch.org/tutorials/

BSD 3-Clause "New" or "Revised" License

8.13k stars 4.04k forks source link

Adding xeon_run_cpu.rst doc #2931

Closed ZailiWang closed 3 months ago

ZailiWang commented 3 months ago

This PR is to add a user guide for torch.backends.xeon.run_cpu script. https://github.com/pytorch/pytorch/blob/main/torch/backends/xeon/run_cpu.py

The content is same with pytorch PR https://github.com/pytorch/pytorch/pull/128099 After some discussion we moved it to tutorials part.

@jingxu10 @jgong5 @svekars @kwen2501 @kurman Please help review it.

cc @sekyondaMeta @svekars @kit1980 @brycebortree

pytorch-bot[bot] commented 3 months ago

:link: Helpful Links

:test_tube: See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/tutorials/2931

:page_facing_up: Preview Python docs built from this PR

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

:heavy_exclamation_mark: 1 Active SEVs

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

Huge queue on Windows runner

:white_check_mark: No Failures

As of commit 40b5da8aecc582e756f25a71b42ee579d4e8eac0 with merge base 3b97695b38b66cbd6d0ede5b8aea8940cf6c8b7d (): :green_heart: Looks good so far! There are no failures yet. :green_heart:

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

facebook-github-bot commented 3 months ago

Hi @ZailiWang!

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!

ZailiWang commented 3 months ago

Have sent mail to cla@meta.com for adding my account into Intel employee list.

svekars commented 3 months ago

also, please sign the CLA

ZailiWang commented 3 months ago

Hi @svekars thanks a lot for your efforts on correcting the expression in the article. I just pushed a commit per your comments, please help review again.

For CLA, I have sent mail to cla@meta.com for adding me into INTEL employee list, now waiting for approval from Intel POC.

jingxu10 commented 3 months ago

Hi @ZailiWang , pls address the comments above.

ZailiWang commented 3 months ago

Hi @svekars seems I cannot trigger the building of the new commit for preview myself. Would you help generate the preview html page again so that we can check the tables with new syntax is good. Also the adjustment of the column widths may be needed.

svekars commented 3 months ago

LGTM - please double check the formatting: https://docs-preview.pytorch.org/pytorch/tutorials/2931/recipes/xeon_run_cpu.html

jingxu10 commented 3 months ago

LGTM