Skip to content

Commit

Permalink
fix zsh install (modelscope#735)
Browse files Browse the repository at this point in the history
  • Loading branch information
tastelikefeet committed Apr 18, 2024
1 parent ee70d5c commit 5b02afe
Show file tree
Hide file tree
Showing 43 changed files with 56 additions and 56 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,11 @@ SWIFT runs in the Python environment. Please ensure your Python version is highe

```shell
# Full capabilities
pip install ms-swift[all] -U
pip install 'ms-swift[all]' -U
# LLM only
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U
# AIGC only
pip install ms-swift[aigc] -U
pip install 'ms-swift[aigc]' -U
# Adapters only
pip install ms-swift -U
```
Expand All @@ -154,7 +154,7 @@ pip install ms-swift -U
```shell
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[llm]
pip install -e '.[llm]'
```

SWIFT depends on torch>=1.13, recommend torch>=2.0.0.
Expand Down
8 changes: 4 additions & 4 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,11 @@ SWIFT在Python环境中运行。请确保您的Python版本高于3.8。

```shell
# 全量能力
pip install ms-swift[all] -U
pip install 'ms-swift[all]' -U
# 仅使用LLM
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U
# 仅使用AIGC
pip install ms-swift[aigc] -U
pip install 'ms-swift[aigc]' -U
# 仅使用Adapters
pip install ms-swift -U
```
Expand All @@ -155,7 +155,7 @@ pip install ms-swift -U
```shell
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[llm]
pip install -e '.[llm]'
```

SWIFT依赖torch>=1.13,建议torch>=2.0.0。
Expand Down
8 changes: 4 additions & 4 deletions docs/source/GetStarted/SWIFT安装.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

```shell
# 全量能力
pip install ms-swift[all] -U
pip install 'ms-swift[all]' -U
# 仅使用LLM
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U
# 仅使用AIGC
pip install ms-swift[aigc] -U
pip install 'ms-swift[aigc]' -U
# 仅使用adapters
pip install ms-swift -U
```
Expand All @@ -20,7 +20,7 @@ pip install ms-swift -U
```shell
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[all]
pip install -e '.[all]'
```

## Notebook环境
Expand Down
2 changes: 1 addition & 1 deletion docs/source/LLM/Agent微调最佳实践.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
# 安装ms-swift
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[llm]
pip install -e '.[llm]'

# 环境对齐 (通常不需要运行. 如果你运行错误, 可以跑下面的代码, 仓库使用最新环境测试)
pip install -r requirements/framework.txt -U
Expand Down
2 changes: 1 addition & 1 deletion docs/source/LLM/Grok训练和推理.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
```shell
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[llm]
pip install -e '.[llm]'
```

## 微调
Expand Down
2 changes: 1 addition & 1 deletion docs/source/LLM/LLM人类对齐训练文档.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
# 安装ms-swift
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[llm]
pip install -e '.[llm]'

# 环境对齐 (通常不需要运行. 如果你运行错误, 可以跑下面的代码, 仓库使用最新环境测试)
pip install -r requirements/framework.txt -U
Expand Down
2 changes: 1 addition & 1 deletion docs/source/LLM/LLM微调文档.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
# 安装ms-swift
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[llm]
pip install -e '.[llm]'

# 如果你想要使用deepspeed.
pip install deepspeed -U
Expand Down
2 changes: 1 addition & 1 deletion docs/source/LLM/LLM推理文档.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ GPU设备: A10, 3090, V100, A100均可.
# 设置pip全局镜像 (加速下载)
pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
# 安装ms-swift
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U

# 如果你想要使用基于auto_gptq的模型进行推理.
# 使用auto_gptq的模型: `https://github.com/modelscope/swift/blob/main/docs/source/LLM/支持的模型和数据集.md#模型`
Expand Down
2 changes: 1 addition & 1 deletion docs/source/LLM/LLM评测文档.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ pip install ms-swift[eval] -U
```shell
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[eval]
pip install -e '.[eval]'
```

## 评测
Expand Down
2 changes: 1 addition & 1 deletion docs/source/LLM/LLM量化文档.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ GPU设备: A10, 3090, V100, A100均可.
# 设置pip全局镜像 (加速下载)
pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
# 安装ms-swift
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U

# 使用awq量化:
# autoawq和cuda版本有对应关系,请按照`https://github.com/casper-hansen/AutoAWQ`选择版本
Expand Down
2 changes: 1 addition & 1 deletion docs/source/LLM/Qwen1.5全流程最佳实践.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

## 环境准备
```shell
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U

# autoawq和cuda版本有对应关系,请按照`https://github.com/casper-hansen/AutoAWQ`选择版本
pip install autoawq
Expand Down
2 changes: 1 addition & 1 deletion docs/source/LLM/VLLM推理加速与部署.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ GPU设备: A10, 3090, V100, A100均可.
# 设置pip全局镜像 (加速下载)
pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
# 安装ms-swift
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U

# vllm与cuda版本有对应关系,请按照`https://docs.vllm.ai/en/latest/getting_started/installation.html`选择版本
pip install vllm -U
Expand Down
2 changes: 1 addition & 1 deletion docs/source/LLM/自我认知微调最佳实践.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# 设置pip全局镜像 (加速下载)
pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
# 安装ms-swift
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U

# 环境对齐 (通常不需要运行. 如果你运行错误, 可以跑下面的代码, 仓库使用最新环境测试)
pip install -r requirements/framework.txt -U
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Multi-Modal/cogvlm最佳实践.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## 环境准备
```shell
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U
```

## 推理
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Multi-Modal/deepseek-vl最佳实践.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## 环境准备
```shell
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U
```

## 推理
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Multi-Modal/internlm-xcomposer2最佳实践.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## 环境准备
```shell
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U
```

## 推理
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Multi-Modal/llava最佳实践.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
```shell
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[llm]
pip install -e '.[llm]'
```

## 推理
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Multi-Modal/minicpm-v-2最佳实践.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## 环境准备
```shell
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U
```

## 推理
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Multi-Modal/minicpm-v最佳实践.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

## 环境准备
```shell
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U
```

模型链接:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Multi-Modal/mplug-owl2最佳实践.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
```shell
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[llm]
pip install -e '.[llm]'
```

模型链接:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Multi-Modal/qwen-audio最佳实践.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

## 环境准备
```shell
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U
```

## 推理
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Multi-Modal/qwen-vl最佳实践.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## 环境准备
```shell
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U
```

## 推理
Expand Down
2 changes: 1 addition & 1 deletion docs/source/Multi-Modal/yi-vl最佳实践.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
```shell
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[llm]
pip install -e '.[llm]'
```

## 推理
Expand Down
8 changes: 4 additions & 4 deletions docs/source_en/GetStarted/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ You can use pip to install:

```shell
# Full capabilities
pip install ms-swift[all] -U
pip install 'ms-swift[all]' -U
# Only use LLM
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U
# Only use AIGC
pip install ms-swift[aigc] -U
pip install 'ms-swift[aigc]' -U
# Only use adapters
pip install ms-swift -U
```
Expand All @@ -20,7 +20,7 @@ pip install ms-swift -U
```shell
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[all]
pip install -e '.[all]'
```

## Notebook Environment
Expand Down
2 changes: 1 addition & 1 deletion docs/source_en/LLM/Agent-best-practice.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ SWIFT supports open-source models, especially small and medium-sized models (7B,
# Install ms-swift
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[llm]
pip install -e '.[llm]'

# Align environment (usually don't need to run. If you get errors, you can run the code below, the repo tests with the latest environment)
pip install -r requirements/framework.txt -U
Expand Down
2 changes: 1 addition & 1 deletion docs/source_en/LLM/Grok-1-best-practice.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This documentation introduces the process of finetuning and inferencing the Grok
```shell
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[llm]
pip install -e '.[llm]'
```

## Finetuning
Expand Down
2 changes: 1 addition & 1 deletion docs/source_en/LLM/LLM-eval.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ or install from source code:
```shell
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[eval]
pip install -e '.[eval]'
```

## Evaluation
Expand Down
2 changes: 1 addition & 1 deletion docs/source_en/LLM/LLM-fine-tuning.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ GPU devices: A10, 3090, V100, A100 are all suitable.
# Install ms-swift
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[llm]
pip install -e '.[llm]'

# If you want to use deepspeed.
pip install deepspeed -U
Expand Down
2 changes: 1 addition & 1 deletion docs/source_en/LLM/LLM-inference.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If you want to use vllm for inference acceleration, you can check out [VLLM Infe
GPU devices: A10, 3090, V100, A100 are all supported.
```bash
# Install ms-swift
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U

# If you want to use models based on auto_gptq for inference.
# Models using auto_gptq: `https://github.com/modelscope/swift/blob/main/docs/source/LLM/Supported Models and Datasets.md#Models`
Expand Down
2 changes: 1 addition & 1 deletion docs/source_en/LLM/LLM-quantization.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Swift supports using AWQ and GPTQ techniques to quantize models. These two quant
GPU devices: A10, 3090, V100, A100 are all supported.
```bash
# Install ms-swift
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U

# Using AWQ quantization:
# AutoAWQ and CUDA versions have a corresponding relationship, please select the version according to `https://github.com/casper-hansen/AutoAWQ`
Expand Down
2 changes: 1 addition & 1 deletion docs/source_en/LLM/Qwen1.5-best-practice.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This introduces how to perform inference, self-cognition fine-tuning, quantizati

## Environment Preparation
```shell
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U

# autoawq version corresponds to cuda version, please choose based on `https://github.com/casper-hansen/AutoAWQ`
pip install autoawq
Expand Down
2 changes: 1 addition & 1 deletion docs/source_en/LLM/RLHF.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ GPU devices: A10, 3090, V100, A100 are all acceptable. For GPUs with memory <=24
# Install ms-swift
git clone https://github.com/modelscope/swift.git
cd swift
pip install -e .[llm]
pip install -e '.[llm]'

# Environment alignment (usually not necessary. If you encounter errors, you can run the following code, the repository uses the latest environment for testing)
pip install -r requirements/framework.txt -U
Expand Down
4 changes: 2 additions & 2 deletions docs/source_en/LLM/Self-cognition-best-practice.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Fine-tune your own large model in just 10 minutes!
# Set the global pip mirror (for faster downloads)
pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
# Install ms-swift
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U

# Environment alignment (usually not necessary to run. If you encounter errors, you can run the following code to test with the latest environment in the repository)
pip install -r requirements/framework.txt -U
Expand Down Expand Up @@ -122,7 +122,7 @@ Fine-tune your own large model in just 10 minutes!
# Set up the global pip mirror (for faster downloading)
pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
# Install ms-swift
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U
# Align the environment (usually not necessary to run. If you get an error, you can run the following code, which has been tested with the latest environment in the repository)
pip install -r requirements/framework.txt -U
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ GPU devices: A10, 3090, V100, A100 are all supported.
# Set pip global mirror (speeds up downloads)
pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
# Install ms-swift
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U

# vllm version corresponds to cuda version, please select version according to `https://docs.vllm.ai/en/latest/getting_started/installation.html`
pip install vllm -U
Expand Down
2 changes: 1 addition & 1 deletion docs/source_en/Multi-Modal/cogvlm-best-practice.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Environment Setup
```shell
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U
```

## Inference
Expand Down
2 changes: 1 addition & 1 deletion docs/source_en/Multi-Modal/deepseek-vl-best-practice.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Environment Preparation
```shell
pip install ms-swift[llm] -U
pip install 'ms-swift[llm]' -U
```

## Inference
Expand Down
Loading

0 comments on commit 5b02afe

Please sign in to comment.