Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Modify install commands for DeepSpeed integration #75

Merged
merged 4 commits into from
Aug 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,19 +103,25 @@ XTuner is a toolkit for efficiently fine-tuning LLM, developed by the [MMRazor](

### Installation

Install XTuner with pip
- Install XTuner via pip

```shell
pip install xtuner
```
```shell
pip install xtuner
```

or with DeepSpeed integration

```shell
pip install 'xtuner[deepspeed]'
```

or from source
- Install XTuner from source

```shell
git clone https://github.com/InternLM/xtuner.git
cd xtuner
pip install -e .
```
```shell
git clone https://github.com/InternLM/xtuner.git
cd xtuner
pip install -e '.[all]'
```

### Chat [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/144OuTVyT_GvFyDMtlSlTzcxYIfnRsklq?usp=sharing)

Expand Down
26 changes: 16 additions & 10 deletions README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,19 +103,25 @@ XTuner 是一个轻量级微调大语言模型的工具库,由 [MMRazor](https

### 安装

使用pip安装XTuner
- 通过 pip 安装 XTuner

```shell
pip install xtuner
```
```shell
pip install xtuner
```

亦可集成 DeepSpeed 安装:

```shell
pip install 'xtuner[deepspeed]'
```

或,从源码安装:
- 从源码安装 XTuner

```shell
git clone https://github.com/InternLM/xtuner.git
cd xtuner
pip install -e .
```
```shell
git clone https://github.com/InternLM/xtuner.git
cd xtuner
pip install -e '.[all]'
```

### 对话 [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/144OuTVyT_GvFyDMtlSlTzcxYIfnRsklq?usp=sharing)

Expand Down
Loading