Skip to content

Commit 3cdaea4

Browse files
sywangyisgugger
andauthored
update doc for perf_train_cpu_many, add intel mpi introduction (#18576)
* update doc for perf_train_cpu_many, add mpi introduction Signed-off-by: Wang, Yi A <[email protected]> * Update docs/source/en/perf_train_cpu_many.mdx Co-authored-by: Sylvain Gugger <[email protected]> * Update docs/source/en/perf_train_cpu_many.mdx Signed-off-by: Wang, Yi A <[email protected]> Signed-off-by: Wang, Yi A <[email protected]> Co-authored-by: Sylvain Gugger <[email protected]>
1 parent 46d0941 commit 3cdaea4

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/source/en/perf_train_cpu_many.mdx

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,22 @@ pip install oneccl_bind_pt=={pytorch_version} -f https://software.intel.com/ipex
3636
```
3737
where `{pytorch_version}` should be your PyTorch version, for instance 1.12.0.
3838
Check more approaches for [oneccl_bind_pt installation](https://github.com/intel/torch-ccl).
39+
Versions of oneCCL and PyTorch must match.
3940

40-
### Usage in Trainer
41+
## Intel® MPI library
42+
Use this standards-based MPI implementation to deliver flexible, efficient, scalable cluster messaging on Intel® architecture. This component is part of the Intel® oneAPI HPC Toolkit.
43+
It can be installed via [MPI](https://www.intel.com/content/www/us/en/developer/articles/tool/oneapi-standalone-components.html#mpi).
44+
45+
Please set the environment by following command before using it.
46+
47+
```
48+
source /opt/intel/oneapi/setvars.sh
49+
```
50+
51+
The following "Usage in Trainer" takes mpirun in Intel® MPI library as an example.
52+
53+
54+
## Usage in Trainer
4155
To enable multi CPU distributed training in the Trainer with the ccl backend, users should add **`--xpu_backend ccl`** in the command arguments.
4256

4357
Let's see an example with the [question-answering example](https://github.com/huggingface/transformers/tree/main/examples/pytorch/question-answering)

0 commit comments

Comments
 (0)