Skip to content

Commit 5ee65b4

Browse files
committed
update readme
1 parent 05ead96 commit 5ee65b4

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This repository holds PyTorch bindings maintained by Intel® for the Intel® one
66

77
[PyTorch](https://github.com/pytorch/pytorch) is an open-source machine learning framework.
88

9-
[Intel® oneCCL](https://github.com/oneapi-src/oneCCL) (collective communications library) is a library for efficient distributed deep learning training implementing such collectives like `allreduce`, `allgather`, `alltoall`. For more information on oneCCL, please refer to the [oneCCL documentation](https://spec.oneapi.com/versions/latest/elements/oneCCL/source/index.html).
9+
[Intel® oneCCL](https://github.com/oneapi-src/oneCCL) (collective communications library) is a library for efficient distributed deep learning training, implementing collectives like `allreduce`, `allgather`, `alltoall`. For more information on oneCCL, please refer to the [oneCCL documentation](https://spec.oneapi.com/versions/latest/elements/oneCCL/source/index.html).
1010

1111
`oneccl_bindings_for_pytorch` module implements PyTorch C10D ProcessGroup API and can be dynamically loaded as external ProcessGroup and only works on Linux platform now.
1212

@@ -50,25 +50,25 @@ We recommend using Anaconda as Python package management system. The followings
5050
| [v1.6.0](https://github.com/pytorch/pytorch/tree/v1.6.0) | [ccl_torch1.6](https://github.com/intel/torch-ccl/tree/ccl_torch1.6) |
5151
| [v1.5-rc3](https://github.com/pytorch/pytorch/tree/v1.5.0-rc3) | [beta09](https://github.com/intel/torch-ccl/tree/beta09) |
5252

53-
The usage details can be found in the README of corresponding branch. The following part is about the usage of v1.9 tag. if you want to use other version of torch-ccl please checkout to that branch(tag). For pytorch-1.5.0-rc3, the [#PR28068](https://github.com/pytorch/pytorch/pull/28068) and [#PR32361](https://github.com/pytorch/pytorch/pull/32361) are need to dynamicall register external ProcessGroup and enable `alltoall` collective communication primitive. The patch file about these two PRs is in `patches` directory and you can use it directly.
53+
The usage details can be found in the README of corresponding branch.
5454

5555
## Requirements
5656

5757
- Python 3.8 or later and a C++17 compiler
5858

59-
- PyTorch v2.1.2
59+
- PyTorch v2.1.0
6060

6161
## Build Option List
6262

6363
The following build options are supported in Intel® oneCCL Bindings for PyTorch*.
6464

6565
| Build Option | Default Value | Description |
6666
| :---------------------------------- | :------------- | :-------------------------------------------------------------------------------------------------- |
67-
| COMPUTE_BACKEND | | Set oneCCL `COMPUTE_BACKEDN`,set to `dpcpp` and use DPC++ Compiler to enable support for Intel XPU |
67+
| COMPUTE_BACKEND | | Set oneCCL `COMPUTE_BACKEND`,set to `dpcpp` and use DPC++ compiler to enable support for Intel XPU |
6868
| USE_SYSTEM_ONECCL | OFF | Use oneCCL library in system |
69-
| CCL_PACKAGE_NAME | oneccl-bind-pt | Set Wheel Name |
70-
| ONECCL_BINDINGS_FOR_PYTORCH_BACKEND | cpu | Set BACKEND |
71-
| CCL_SHA_VERSION | False | add git head sha version to Wheel name |
69+
| CCL_PACKAGE_NAME | oneccl-bind-pt | Set wheel name |
70+
| ONECCL_BINDINGS_FOR_PYTORCH_BACKEND | cpu | Set backend |
71+
| CCL_SHA_VERSION | False | Add git head sha version to be wheel name |
7272

7373
## Launch Option List
7474

@@ -100,14 +100,14 @@ The following launch options are supported in Intel® oneCCL Bindings for PyTorc
100100
# for XPU Backend: use DPC++ Compiler to enable support for Intel XPU
101101
# build with oneCCL from third party
102102
COMPUTE_BACKEND=dpcpp python setup.py install
103-
# build without oneCCL
103+
# build with oneCCL from basekit
104104
export INTELONEAPIROOT=${HOME}/intel/oneapi
105105
USE_SYSTEM_ONECCL=ON COMPUTE_BACKEND=dpcpp python setup.py install
106106
```
107107

108108
### Install PreBuilt Wheel
109109

110-
Wheel files are avaiable for the following Python versions.
110+
Wheel files are available for the following Python versions.
111111

112112
| Extension Version | Python 3.6 | Python 3.7 | Python 3.8 | Python 3.9 | Python 3.10 | Python 3.11 |
113113
| :---------------: | :--------: | :--------: | :--------: | :--------: | :---------: | :---------: |

0 commit comments

Comments
 (0)