Adding xeon_run_cpu.rst doc #2931

ZailiWang · 2024-06-14T02:48:46Z

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 pytorch/pytorch#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 · 2024-06-14T02:48:50Z

🔗 Helpful Links

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

📄 Preview Python docs built from this PR

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:

Huge queue on Windows runner

✅ No Failures

As of commit 40b5da8 with merge base 3b97695 ():
💚 Looks good so far! There are no failures yet. 💚

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

facebook-github-bot · 2024-06-14T02:48:52Z

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 · 2024-06-14T03:55:32Z

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

jgong5

Some minor revision suggested. Others LGTM.

recipes_source/recipes_index.rst

svekars

An editorial pass - thank you!

recipes_source/xeon_run_cpu.rst

svekars · 2024-06-17T15:53:52Z

recipes_source/xeon_run_cpu.rst

+helping the users try out an optimal coordination of resource utilization for the specific workloads.
+
+Prerequisites
+-------------


please add the prerequisites

Here by "prerequisites" I mean the users should install numactl/IntelOMP/TCMalloc/JeMalloc in prior to running the script, but seems misleading.
I changed the sections title to "Introduction of the Optimizations", and the following sub-titles are changed "Applying NUMA Access Control", "Using Intel(R) OpenMP Runtime Library" and "Choosing an Optimized Memory Allocator". Does it look clearer?

recipes_source/xeon_run_cpu.rst

svekars · 2024-06-17T20:05:23Z

also, please sign the CLA

ZailiWang · 2024-06-18T06:41:18Z

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.

svekars · 2024-06-20T17:31:32Z

recipes_source/xeon_run_cpu.rst

+What You Will Learn
+-------------------
+
+* How to utilize tools like ``numactl``, ``taskset``, Intel(R) OpenMP Runtime Library and optimized memory allocators such as ``TCMalloc`` and ``JeMalloc`` for enhanced performance.


Suggested change

* How to utilize tools like ``numactl``, ``taskset``, Intel(R) OpenMP Runtime Library and optimized memory allocators such as ``TCMalloc`` and ``JeMalloc`` for enhanced performance.

* How to utilize tools like ``numactl``, ``taskset``, Intel(R) OpenMP Runtime Library and

optimized memory allocators such as ``TCMalloc`` and ``JeMalloc`` for enhanced performance.

Hi @svekars , it looks like we needn't separate these 2 sentences in 2 lines since they are bullets and have asterisks at the beginning.
With this change the output doc has 2 paragraphs for each bullet.

recipes_source/xeon_run_cpu.rst

svekars · 2024-06-20T17:35:48Z

recipes_source/xeon_run_cpu.rst

+----------------------+------+---------------+-------------------------------------------------------------------------------------------------------------------------+
+| knob                 | type | default value | help                                                                                                                    |


not sure why by the header row (Defaul value) in this table looks a bit weird:

I myself prefer list-tables for tables like this, For example:

.. list-table:: :widths: 25 10 15 50 :header-rows: 1 * - knob - type - default value - help * - ``-h``, ``--help`` - - - Show the help message and exit. * - ``-m``, ``--module`` - - - Changes each process to interpret the launch script as a python module, executing with the same behavior as "python -m". * - ``--no-python`` - bool - False - Do not prepend the program with "python" - just exec it directly. Useful when the script is not a Python script. * - ``--log-path`` - str - '' - The log file directory. Default path is ``''``, which means disable logging to files. * - ``--log-file-prefix`` - str - 'run' - log file name prefix.

Thanks. I pushed a commit updating the formatting syntax of the tables per your advice.
Not deleting the old formatted tables for comparison.

jingxu10 · 2024-06-20T22:54:18Z

Hi @ZailiWang , pls address the comments above.

ZailiWang · 2024-06-21T02:47:02Z

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.

…ssion

svekars · 2024-06-24T16:29:44Z

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

jingxu10 · 2024-06-24T21:02:59Z

LGTM

ZailiWang added 2 commits June 14, 2024 07:19

adding tutorial for xeon.run_cpu script usage.

619b8fc

add new doc link in toctree

558a525

Merge branch 'main' into main

01b5044

jgong5 approved these changes Jun 14, 2024

View reviewed changes

recipes_source/recipes_index.rst Outdated Show resolved Hide resolved

recipes_source/recipes_index.rst Outdated Show resolved Hide resolved

ZailiWang added 2 commits June 14, 2024 12:33

corrections

70e21f5

Merge branch 'main' of https://github.com/ZailiWang/pt_tutorials

8ee714b

svekars reviewed Jun 17, 2024

View reviewed changes

updates per comment

56187d8

ZailiWang and others added 3 commits June 18, 2024 14:41

Merge branch 'main' into main

280fcdc

corrections

6ea7c10

Merge branch 'main' into main

beb945a

svekars added docathon-h1-2024 and removed docathon-h1-2024 labels Jun 18, 2024

Merge branch 'main' into main

d06fb5f

facebook-github-bot added the cla signed label Jun 20, 2024

svekars reviewed Jun 20, 2024

View reviewed changes

ZailiWang and others added 2 commits June 21, 2024 09:04

Merge branch 'pytorch:main' into main

73fe42c

[trial] change table format

517e66f

svekars and others added 5 commits June 21, 2024 10:00

Remove duplicate tables

ed63b12

Update xeon_run_cpu.rst

391f4ad

grammar correction: know explanations should not use imperative expre…

1bdfb89

…ssion

correct trademark sign

9879170

Update xeon_run_cpu.rst

40b5da8

svekars approved these changes Jun 24, 2024

View reviewed changes

svekars merged commit cbde504 into pytorch:main Jun 24, 2024
20 checks passed

ZailiWang mentioned this pull request Aug 1, 2024

fix xeon_run_cpu.html link #2989

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding xeon_run_cpu.rst doc #2931

Adding xeon_run_cpu.rst doc #2931

ZailiWang commented Jun 14, 2024 •

edited by pytorch-bot bot

Loading

pytorch-bot bot commented Jun 14, 2024 •

edited

Loading

facebook-github-bot commented Jun 14, 2024

ZailiWang commented Jun 14, 2024

jgong5 left a comment

svekars left a comment

svekars Jun 17, 2024

ZailiWang Jun 18, 2024 •

edited

Loading

svekars commented Jun 17, 2024

ZailiWang commented Jun 18, 2024

svekars Jun 20, 2024

ZailiWang Jun 24, 2024

svekars Jun 20, 2024

ZailiWang Jun 21, 2024

jingxu10 commented Jun 20, 2024

ZailiWang commented Jun 21, 2024

svekars commented Jun 24, 2024

jingxu10 commented Jun 24, 2024

	* How to utilize tools like ``numactl``, ``taskset``, Intel(R) OpenMP Runtime Library and optimized memory allocators such as ``TCMalloc`` and ``JeMalloc`` for enhanced performance.
	* How to utilize tools like ``numactl``, ``taskset``, Intel(R) OpenMP Runtime Library and
	optimized memory allocators such as ``TCMalloc`` and ``JeMalloc`` for enhanced performance.

		+----------------------+------+---------------+-------------------------------------------------------------------------------------------------------------------------+
		\| knob \| type \| default value \| help \|

Adding xeon_run_cpu.rst doc #2931

Adding xeon_run_cpu.rst doc #2931

Conversation

ZailiWang commented Jun 14, 2024 • edited by pytorch-bot bot Loading

pytorch-bot bot commented Jun 14, 2024 • edited Loading

🔗 Helpful Links

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

❗ 1 Active SEVs

✅ No Failures

facebook-github-bot commented Jun 14, 2024

Action Required

Process

ZailiWang commented Jun 14, 2024

jgong5 left a comment

Choose a reason for hiding this comment

svekars left a comment

Choose a reason for hiding this comment

svekars Jun 17, 2024

Choose a reason for hiding this comment

ZailiWang Jun 18, 2024 • edited Loading

Choose a reason for hiding this comment

svekars commented Jun 17, 2024

ZailiWang commented Jun 18, 2024

svekars Jun 20, 2024

Choose a reason for hiding this comment

ZailiWang Jun 24, 2024

Choose a reason for hiding this comment

svekars Jun 20, 2024

Choose a reason for hiding this comment

ZailiWang Jun 21, 2024

Choose a reason for hiding this comment

jingxu10 commented Jun 20, 2024

ZailiWang commented Jun 21, 2024

svekars commented Jun 24, 2024

jingxu10 commented Jun 24, 2024

ZailiWang commented Jun 14, 2024 •

edited by pytorch-bot bot

Loading

pytorch-bot bot commented Jun 14, 2024 •

edited

Loading

ZailiWang Jun 18, 2024 •

edited

Loading