Skip to content

Commit 3e01fda

Browse files
authored
Update README.md (#106)
1 parent e7fcd53 commit 3e01fda

File tree

1 file changed

+41
-19
lines changed

1 file changed

+41
-19
lines changed

README.md

+41-19
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ The table below shows which functions are available for use with CPU / Intel dGP
1616

1717
| | CPU | GPU |
1818
| :--------------- | :---: | :---: |
19-
| `send` | × | × |
20-
| `recv` | × | × |
19+
| `send` | × | |
20+
| `recv` | × | |
2121
| `broadcast` |||
2222
| `all_reduce` |||
2323
| `reduce` |||
2424
| `all_gather` |||
2525
| `gather` |||
2626
| `scatter` | × | × |
27-
| `reduce_scatter` | × | × |
27+
| `reduce_scatter` | | |
2828
| `all_to_all` |||
2929
| `barrier` |||
3030

@@ -96,23 +96,48 @@ The following lunch options are supported in Intel® oneCCL Bindings for PyTorch
9696
# build with oneCCL from third party
9797
COMPUTE_BACKEND=dpcpp python setup.py install
9898
# build without oneCCL
99-
BUILD_NO_ONECCL_PACKAGE=ON COMPUTE_BACKEND=dpcpp python setup.py install
99+
export INTELONEAPIROOT=${HOME}/intel/oneapi
100+
USE_SYSTEM_ONECCL=ON COMPUTE_BACKEND=dpcpp python setup.py install
100101
```
101102

102103
### Install PreBuilt Wheel
103104

104105
Wheel files are avaiable for the following Python versions.
105106

106-
| Extension Version | Python 3.6 | Python 3.7 | Python 3.8 | Python 3.9 | Python 3.10 |
107-
| :---------------: | :--------: | :--------: | :--------: | :--------: | :---------: |
108-
| 1.13 | |||||
109-
| 1.12.100 | |||||
110-
| 1.12.0 | |||||
111-
| 1.11.0 | |||||
112-
| 1.10.0 ||||| |
107+
| Extension Version | Python 3.6 | Python 3.7 | Python 3.8 | Python 3.9 | Python 3.10 | Python 3.11 |
108+
| :---------------: | :--------: | :--------: | :--------: | :--------: | :---------: | :---------: |
109+
| 2.0.100 | | |||||
110+
| 1.13 | ||||| |
111+
| 1.12.100 | ||||| |
112+
| 1.12.0 | ||||| |
113+
| 1.11.0 | ||||| |
114+
| 1.10.0 ||||| | |
113115

114116
```bash
115-
python -m pip install oneccl_bind_pt==1.13 -f https://developer.intel.com/ipex-whl-stable-cpu
117+
python -m pip install oneccl_bind_pt==2.0.100 -f https://developer.intel.com/ipex-whl-stable-xpu
118+
```
119+
120+
### Runtime Dynamic Linking
121+
122+
- If oneccl_bindings_for_pytorch is built without oneCCL and use oneCCL in system, dynamic link oneCCl from oneAPI basekit (recommended usage):
123+
124+
```bash
125+
source $basekit_root/ccl/latest/env/vars.sh
126+
```
127+
128+
Note: Make sure you have installed [basekit](https://www.intel.com/content/www/us/en/developer/tools/oneapi/toolkits.html#base-kit) when using Intel® oneCCL Bindings for Pytorch\* on Intel® GPUs.
129+
130+
- If oneccl_bindings_for_pytorch is built with oneCCL from third party or installed from prebuilt wheel:
131+
Dynamic link oneCCL and Intel MPI libraries:
132+
133+
```bash
134+
source $(python -c "import oneccl_bindings_for_pytorch as torch_ccl;print(torch_ccl.cwd)")/env/setvars.sh
135+
```
136+
137+
Dynamic link oneCCL only (not including Intel MPI):
138+
139+
```bash
140+
source $(python -c "import oneccl_bindings_for_pytorch as torch_ccl;print(torch_ccl.cwd)")/env/vars.sh
116141
```
117142

118143
## Usage
@@ -145,15 +170,12 @@ model = torch.nn.parallel.DistributedDataParallel(model, ...)
145170
...
146171
```
147172

148-
(oneccl_bindings_for_pytorch is installed along with the MPI tool set.)
173+
(oneccl_bindings_for_pytorch is built without oneCCL, use oneCCL and MPI(if needed) in system)
149174

150175
```bash
151-
152-
source <oneccl_bindings_for_pytorch_path>/env/setvars.sh
153-
154-
# eg:
155-
# $ oneccl_bindings_for_pytorch_path=$(python -c "from oneccl_bindings_for_pytorch import cwd; print(cwd)")
156-
# $ source $oneccl_bindings_for_pytorch_path/env/setvars.sh
176+
source $basekit_root/ccl/latest/env/vars.sh
177+
source $basekit_root/mpi/latest/env/vars.sh
178+
```
157179

158180
mpirun -n <N> -ppn <PPN> -f <hostfile> python example.py
159181
```

0 commit comments

Comments
 (0)