github/ColossalAI
1
0
Fork 0
mirror of https://github.com/hpcaitech/ColossalAI.git synced 2025-09-17 23:18:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

update setup and workflow (#222)

Browse Source
This commit is contained in:
ver217
2022-02-14 17:09:30 +08:00
committed by Frank Lee
parent 3a1a9820b0
commit 578ea0583b
5 changed files with 159 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -17,9 +17,26 @@ An integrated large-scale model training system with efficient parallelization t
## Installation
### Install From Source (Recommended)
### PyPI
> We **recommend** you to install from source as the Colossal-AI is updating frequently in the early versions. The documentation will be in line with the main branch of the repository. Feel free to raise an issue if you encounter any problem. :)
```bash
pip install colossalai
```
This command will install CUDA extension if your have installed CUDA, NVCC and torch.
If you don't want to install CUDA extension, you should add `--global-option="--no_cuda_ext"`, like:
```bash
pip install colossalai --global-option="--no_cuda_ext"
```
If you want to use `ZeRO`, you can run:
```bash
pip install colossalai[zero]
```
### Install From Source
> The documentation will be in line with the main branch of the repository. Feel free to raise an issue if you encounter any problem. :)
```shell
git clone https://github.com/hpcaitech/ColossalAI.git
@@ -31,19 +48,12 @@ pip install -r requirements/requirements.txt
pip install .
```
Install and enable CUDA kernel fusion (compulsory installation when using fused optimizer)
If you don't want to install and enable CUDA kernel fusion (compulsory installation when using fused optimizer):
```shell
pip install -v --no-cache-dir --global-option="--cuda_ext" .
pip install --global-option="--no_cuda_ext" .
```
### PyPI
```bash
pip install colossalai
```
## Use Docker
Run the following command to build a docker image from Dockerfile provided.