github/ColossalAI
1
0
Fork 0
mirror of https://github.com/hpcaitech/ColossalAI.git synced 2025-09-11 05:49:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

[doc] specified operating system requirement (#3019)

Browse Source 
* [doc] specified operating system requirement

* polish code
This commit is contained in:
Frank Lee
2023-03-07 18:04:10 +08:00
committed by GitHub
parent 378d827c6b
commit ea0b52c12e
5 changed files with 44 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/source/en/get_started/installation.md
View File

@@ -1,9 +1,13 @@
<!-- doc-test-command: echo "installation.md does not need test" -->
# Setup
> Colossal-AI currently only supports the Linux operating system and has not been tested on other OS such as Windows and macOS.
>
> Environment Requirement: PyTorch 1.10 ~ 1.12 (WIP higher version), Python >= 3.7, CUDA >= 11.0. 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.
Requirements:
- PyTorch >= 1.11 (PyTorch 2.x in progress)
- Python >= 3.7
- CUDA >= 11.0
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.
## Download From PyPI
@@ -14,6 +18,8 @@ You can install Colossal-AI with
pip install colossalai
```
**Note: only Linux is supported for now**
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