|
1 | 1 | # Intel® Extension for DeepSpeed* |
2 | 2 | Intel® Extension for DeepSpeed* is an extension that brings Intel GPU (XPU) support to DeepSpeed(https://github.com/Microsoft/DeepSpeed). It comes with the following components: |
3 | 3 | 1. DeepSpeed Accelerator Interface implementation |
4 | | -2. DeepSpeed op builders implmentation for XPU |
| 4 | +2. DeepSpeed op builder implmentation for XPU |
5 | 5 | 3. DeepSpeed op builder kernel code |
6 | 6 |
|
7 | 7 | DeepSpeed would automatically use Intel® Extension for DeepSpeed* when it is installed as a python package. After installation, models ported for DeepSpeed Accelerator Interface that run on DeepSpeed could run on Intel GPU device. |
8 | 8 |
|
9 | | -Usage: |
10 | | -1. Install Intel® Extension for DeepSpeed* |
| 9 | +## Installation |
11 | 10 |
|
12 | | -`python setup.py install` |
| 11 | +1. Install Intel® Extension for PyTorch* following [Installation Guide](https://intel.github.io/intel-extension-for-pytorch/xpu/latest/tutorials/installation.html) |
13 | 12 |
|
14 | | -2. Install DeepSpeed |
| 13 | +2. Install Intel® Extension for DeepSpeed* |
| 14 | +```python |
| 15 | +pip install intel-extension-for-deepspeed |
| 16 | +``` |
| 17 | + Or, you can build from source: |
| 18 | +```python |
| 19 | +source ${DPCPPROOT}/env/vars.sh |
| 20 | +python setup.py install |
| 21 | +``` |
| 22 | +Generally, DPCPPROOT is /opt/intel/oneapi/compiler/latest for root account, ${HOME}/intel/oneapi/compiler/latest for other accounts. |
15 | 23 |
|
16 | | -The DeepSpeed ops can be built just-in-time(JIT) and dynamically link at runtime, which is enabled by default. |
17 | | -`python setup.py install` |
| 24 | +3. Install DeepSpeed |
18 | 25 |
|
19 | | -Alternatives: Pre-Install DeepSpeed Ops |
20 | | -To disable JIT and use pre-install DeepSpeed ops, it can be built by setting the DS_BUILD_OPS environment variables, for examples, DS_BUILD_UTILS=1. |
21 | | -`CC=dpcpp CFLAGS=-fPIC CXX=dpcpp CXXFLAGS=-fPIC DS_BUILD_DEVICE=dpcpp DS_BUILD_CPU_ADAM=1 DS_BUILD_FUSED_ADAM=1 DS_BUILD_QUANTIZER=1 DS_BUILD_TRANSFORMER=1 DS_BUILD_UTILS=1 python setup.py install` |
| 26 | +```python |
| 27 | +pip install deepspeed |
| 28 | +``` |
| 29 | +## Get Started |
| 30 | +Refer to [examples](https://github.com/intel/intel-extension-for-deepspeed/tree/main/examples#readme) |
| 31 | + |
| 32 | + |
| 33 | +## Security Policy |
| 34 | +Please report security issues or vulnerabilities to the [Intel Security Center]. |
| 35 | + |
| 36 | +For more information on how Intel works to resolve security issues, see |
| 37 | +[Vulnerability Handling Guidelines]. |
| 38 | + |
| 39 | +[Intel Security Center]:https://www.intel.com/security |
| 40 | +[Vulnerability Handling Guidelines]:https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html |
0 commit comments