[doc] specified operating system requirement (#3019)

* [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

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

View File

@@ -1,7 +1,12 @@
# 安装
> Colossal-AI 目前仅支持Linux操作系统没有在其他操作系统如Windows和macOS进行测试
>
> 环境要求: PyTorch 1.10 ~ 1.12 (更新版本正在兼容中), Python >= 3.7, CUDA >= 11.0。如果你遇到安装问题,可以向本项目 [反馈](https://github.com/hpcaitech/ColossalAI/issues/new/choose)。
环境要求:
- PyTorch >= 1.11 (PyTorch 2.x 正在适配中)
- Python >= 3.7
- CUDA >= 11.0
如果你遇到安装问题,可以向本项目 [反馈](https://github.com/hpcaitech/ColossalAI/issues/new/choose)。
## 从PyPI上安装
@@ -11,6 +16,8 @@
pip install colossalai
```
**注现在只支持Linux。**
如果你想同时安装PyTorch扩展的话可以添加`CUDA_EXT=1`。如果不添加的话PyTorch扩展会在运行时自动安装。
```shell