2023-02-09 06:21:38 +00:00
# Setup
2023-03-07 10:04:10 +00:00
Requirements:
2023-12-15 10:16:48 +00:00
- PyTorch >= 1.11 and PyTorch < = 2.1
2023-03-07 10:04:10 +00:00
- Python >= 3.7
- CUDA >= 11.0
2023-04-10 09:37:16 +00:00
- [NVIDIA GPU Compute Capability ](https://developer.nvidia.com/cuda-gpus ) >= 7.0 (V100/RTX20 and higher)
- Linux OS
2023-03-09 10:10:45 +00:00
2023-03-07 10:04:10 +00:00
If you encounter any problem about installation, you may want to raise an [issue ](https://github.com/hpcaitech/ColossalAI/issues/new/choose ) in this repository.
2023-02-28 07:39:51 +00:00
2023-02-09 06:21:38 +00:00
## Download From PyPI
You can install Colossal-AI with
```shell
pip install colossalai
```
2023-03-07 10:04:10 +00:00
**Note: only Linux is supported for now**
2023-02-09 06:21:38 +00:00
If you want to build PyTorch extensions during installation, you can use the command below. Otherwise, the PyTorch extensions will be built during runtime.
```shell
2024-02-19 08:54:03 +00:00
BUILD_EXT=1 pip install colossalai
2023-02-09 06:21:38 +00:00
```
## Download From Source
[doc] update booster tutorials (#3718)
* [booster] update booster tutorials#3717
* [booster] update booster tutorials#3717, fix
* [booster] update booster tutorials#3717, update setup doc
* [booster] update booster tutorials#3717, update setup doc
* [booster] update booster tutorials#3717, update setup doc
* [booster] update booster tutorials#3717, update setup doc
* [booster] update booster tutorials#3717, update setup doc
* [booster] update booster tutorials#3717, update setup doc
* [booster] update booster tutorials#3717, rename colossalai booster.md
* [booster] update booster tutorials#3717, rename colossalai booster.md
* [booster] update booster tutorials#3717, rename colossalai booster.md
* [booster] update booster tutorials#3717, fix
* [booster] update booster tutorials#3717, fix
* [booster] update tutorials#3717, update booster api doc
* [booster] update tutorials#3717, modify file
* [booster] update tutorials#3717, modify file
* [booster] update tutorials#3717, modify file
* [booster] update tutorials#3717, modify file
* [booster] update tutorials#3717, modify file
* [booster] update tutorials#3717, modify file
* [booster] update tutorials#3717, modify file
* [booster] update tutorials#3717, fix reference link
* [booster] update tutorials#3717, fix reference link
* [booster] update tutorials#3717, fix reference link
* [booster] update tutorials#3717, fix reference link
* [booster] update tutorials#3717, fix reference link
* [booster] update tutorials#3717, fix reference link
* [booster] update tutorials#3717, fix reference link
* [booster] update tutorials#3713
* [booster] update tutorials#3713, modify file
2023-05-18 03:41:56 +00:00
> The version of Colossal-AI will be in line with the main branch of the repository. Feel free to raise an issue if you encounter any problem.
2023-02-09 06:21:38 +00:00
```shell
git clone https://github.com/hpcaitech/ColossalAI.git
cd ColossalAI
# install dependency
pip install -r requirements/requirements.txt
# install colossalai
2024-02-19 08:54:03 +00:00
BUILD_EXT=1 pip install .
2023-02-09 06:21:38 +00:00
```
2024-03-05 07:35:54 +00:00
If you don't want to install and enable CUDA kernel fusion (compulsory installation when using fused optimizer), just don't specify the `BUILD_EXT` :
2023-02-09 06:21:38 +00:00
```shell
[doc] update booster tutorials (#3718)
* [booster] update booster tutorials#3717
* [booster] update booster tutorials#3717, fix
* [booster] update booster tutorials#3717, update setup doc
* [booster] update booster tutorials#3717, update setup doc
* [booster] update booster tutorials#3717, update setup doc
* [booster] update booster tutorials#3717, update setup doc
* [booster] update booster tutorials#3717, update setup doc
* [booster] update booster tutorials#3717, update setup doc
* [booster] update booster tutorials#3717, rename colossalai booster.md
* [booster] update booster tutorials#3717, rename colossalai booster.md
* [booster] update booster tutorials#3717, rename colossalai booster.md
* [booster] update booster tutorials#3717, fix
* [booster] update booster tutorials#3717, fix
* [booster] update tutorials#3717, update booster api doc
* [booster] update tutorials#3717, modify file
* [booster] update tutorials#3717, modify file
* [booster] update tutorials#3717, modify file
* [booster] update tutorials#3717, modify file
* [booster] update tutorials#3717, modify file
* [booster] update tutorials#3717, modify file
* [booster] update tutorials#3717, modify file
* [booster] update tutorials#3717, fix reference link
* [booster] update tutorials#3717, fix reference link
* [booster] update tutorials#3717, fix reference link
* [booster] update tutorials#3717, fix reference link
* [booster] update tutorials#3717, fix reference link
* [booster] update tutorials#3717, fix reference link
* [booster] update tutorials#3717, fix reference link
* [booster] update tutorials#3713
* [booster] update tutorials#3713, modify file
2023-05-18 03:41:56 +00:00
pip install .
2023-02-09 06:21:38 +00:00
```
2023-03-09 10:10:45 +00:00
2023-05-25 06:14:34 +00:00
For Users with CUDA 10.2, you can still build ColossalAI from source. However, you need to manually download the cub library and copy it to the corresponding directory.
```bash
# clone the repository
git clone https://github.com/hpcaitech/ColossalAI.git
cd ColossalAI
# download the cub library
wget https://github.com/NVIDIA/cub/archive/refs/tags/1.8.0.zip
unzip 1.8.0.zip
cp -r cub-1.8.0/cub/ colossalai/kernel/cuda_native/csrc/kernels/include/
# install
2024-02-19 08:54:03 +00:00
BUILD_EXT=1 pip install .
2023-05-25 06:14:34 +00:00
```
2023-03-09 10:10:45 +00:00
<!-- doc - test - command: echo "installation.md does not need test" -->