Skip to content

Commit

Permalink
Update README.md (#34)
Browse files Browse the repository at this point in the history
  • Loading branch information
rogerxfeng8 authored Jun 29, 2023
1 parent 05dc7d3 commit c496881
Showing 1 changed file with 29 additions and 10 deletions.
39 changes: 29 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,40 @@
# Intel® Extension for DeepSpeed*
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:
1. DeepSpeed Accelerator Interface implementation
2. DeepSpeed op builders implmentation for XPU
2. DeepSpeed op builder implmentation for XPU
3. DeepSpeed op builder kernel code

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.

Usage:
1. Install Intel® Extension for DeepSpeed*
## Installation

`python setup.py install`
1. Install Intel® Extension for PyTorch* following [Installation Guide](https://intel.github.io/intel-extension-for-pytorch/xpu/latest/tutorials/installation.html)

2. Install DeepSpeed
2. Install Intel® Extension for DeepSpeed*
```python
pip install intel-extension-for-deepspeed
```
Or, you can build from source:
```python
source ${DPCPPROOT}/env/vars.sh
python setup.py install
```
Generally, DPCPPROOT is /opt/intel/oneapi/compiler/latest for root account, ${HOME}/intel/oneapi/compiler/latest for other accounts.

The DeepSpeed ops can be built just-in-time(JIT) and dynamically link at runtime, which is enabled by default.
`python setup.py install`
3. Install DeepSpeed

Alternatives: Pre-Install DeepSpeed Ops
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.
`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`
```python
pip install deepspeed
```
## Get Started
Refer to [examples](https://github.com/intel/intel-extension-for-deepspeed/tree/main/examples#readme)


## Security Policy
Please report security issues or vulnerabilities to the [Intel Security Center].

For more information on how Intel works to resolve security issues, see
[Vulnerability Handling Guidelines].

[Intel Security Center]:https://www.intel.com/security
[Vulnerability Handling Guidelines]:https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html

0 comments on commit c496881

Please sign in to comment.