Skip to content
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.

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

Add documentation for CPU Affinity usage #6922

Merged
merged 26 commits into from
Mar 20, 2023

Conversation

JakubPietrakIntel
Copy link
Contributor

@JakubPietrakIntel JakubPietrakIntel commented Mar 15, 2023

Adding a manual page in https://pytorch-geometric.readthedocs.io Advanced Topics: "CPU Affinity for PyG Workloads"
The manual explains how one can set a CPU affinity mask to improve the performance of PyG workloads.
It covers DataLoader feature enable_cpu_affinity() that can be enabled as contextmanager from AffinityMixin class, and other tools such as numactl and affinitization commands from libiomp5 and libgomp libraries.
The article provides sources to Pytorch Tutorials, where an advanced user may found more information on the methods used to maximize CPU performance with affinity masks.

@rusty1s rusty1s changed the title Add manual in pygdocs Advanced Topics for CPU Affinity Add documentation for CPU Affinity usage Mar 16, 2023
@codecov
Copy link

codecov bot commented Mar 16, 2023

Codecov Report

Merging #6922 (092a505) into master (06ac5a4) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head 092a505 differs from pull request most recent head c3e725f. Consider uploading reports for the commit c3e725f to get more accurate results

@@           Coverage Diff           @@
##           master    #6922   +/-   ##
=======================================
  Coverage   91.46%   91.46%           
=======================================
  Files         431      431           
  Lines       23457    23458    +1     
=======================================
+ Hits        21454    21455    +1     
  Misses       2003     2003           
Impacted Files Coverage Δ
torch_geometric/loader/__init__.py 100.00% <100.00%> (ø)
torch_geometric/loader/mixin.py 87.50% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@JakubPietrakIntel JakubPietrakIntel marked this pull request as ready for review March 16, 2023 15:21
@JakubPietrakIntel JakubPietrakIntel enabled auto-merge (squash) March 17, 2023 12:26
@rusty1s rusty1s disabled auto-merge March 20, 2023 11:44
@rusty1s rusty1s enabled auto-merge (squash) March 20, 2023 11:47
@rusty1s rusty1s merged commit bf96b63 into pyg-team:master Mar 20, 2023
@JakubPietrakIntel JakubPietrakIntel deleted the affinity_docs branch February 27, 2024 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants