update docs

InternLM · Oct 18, 2023 · 68cd9f2 · 68cd9f2
1 parent 2054d63
commit 68cd9f2
Show file tree

Hide file tree

Showing 12 changed files with 18 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -99,7 +99,7 @@ And the request throughput of TurboMind is 30% higher than vLLM.
 Install lmdeploy with pip ( python 3.8+) or [from source](./docs/en/build.md)
 
 ```shell
-pip install lmdeploy
+pip install lmdeploy[all]
 ```
 
 ### Deploy InternLM
@@ -181,6 +181,7 @@ bash workspace/service_docker_up.sh
 Then, you can communicate with the inference server by command line,
 
 ```shell
+python3 -m pip install tritonclient[grpc]
 python3 -m lmdeploy.serve.client {server_ip_addresss}:33337
 ```
 

diff --git a/README_zh-CN.md b/README_zh-CN.md
@@ -100,7 +100,7 @@ TurboMind 的 output token throughput 超过 2000 token/s, 整体比 DeepSpeed
 使用 pip ( python 3.8+) 安装 LMDeploy，或者[源码安装](./docs/zh_cn/build.md)
 
 ```shell
-pip install lmdeploy
+pip install lmdeploy[all]
 ```
 
 ### 部署 InternLM
@@ -181,6 +181,7 @@ bash workspace/service_docker_up.sh
 你可以通过命令行方式与推理服务进行对话：
 
 ```shell
+python3 -m pip install tritonclient[grpc]
 python3 -m lmdeploy.serve.client {server_ip_addresss}:33337
 ```
 

diff --git a/docs/en/faq.md b/docs/en/faq.md
@@ -17,7 +17,7 @@ It may have been caused by the following reasons.
 1. You haven't installed lmdeploy's precompiled package. `_turbomind` is the pybind package of c++ turbomind, which involves compilation. It is recommended that you install the precompiled one.
 
 ```shell
-pip install lmdeploy
+pip install lmdeploy[all]
 ```
 
 2. If you have installed it and still encounter this issue, it is probably because you are executing turbomind-related command in the root directory of lmdeploy source code. Switching to another directory will fix it
@@ -26,7 +26,7 @@ pip install lmdeploy
 
 ### libnccl.so.2 not found
 
-Make sure you have install lmdeploy (>=v0.0.5) through `pip install lmdeploy`.
+Make sure you have install lmdeploy (>=v0.0.5) through `pip install lmdeploy[all]`.
 
 If the issue still exists after lmdeploy installation, add the path of `libnccl.so.2` to environment variable LD_LIBRARY_PATH.
 

diff --git a/docs/en/supported_models/codellama.md b/docs/en/supported_models/codellama.md
@@ -26,7 +26,7 @@ Based on the above table, download the model that meets your requirements. Execu
 
 ```shell
 # install lmdeploy
-python3 -m pip install lmdeploy
+python3 -m pip install lmdeploy[all]
 
 # convert weight layout
 python3 -m lmdeploy.serve.turbomind.deploy codellama /the/path/of/codellama/model

diff --git a/docs/en/w4a16.md b/docs/en/w4a16.md
@@ -5,7 +5,7 @@ LMDeploy supports LLM model inference of 4-bit weight, with the minimum requirem
 Before proceeding with the inference, please ensure that lmdeploy is installed.
 
 ```shell
-pip install lmdeploy
+pip install lmdeploy[all]
 ```
 
 ## 4-bit LLM model Inference

diff --git a/docs/zh_cn/faq.md b/docs/zh_cn/faq.md
@@ -17,7 +17,7 @@ pip install --upgrade mmengine
 1. 您没有安装 lmdeploy 的预编译包。`_turbomind`是 turbomind c++ 的 pybind部分，涉及到编译。推荐您直接安装预编译包。
 
 ```
-pip install lmdeploy
+pip install lmdeploy[all]
 ```
 
 2. 如果已经安装了，还是出现这个问题，请检查下执行目录。不要在 lmdeploy 的源码根目录下执行 python -m lmdeploy.turbomind.\*下的package，换到其他目录下执行。
@@ -26,7 +26,7 @@ pip install lmdeploy
 
 ### libnccl.so.2 not found
 
-确保通过 `pip install lmdeploy` 安装了 lmdeploy (>=v0.0.5)。
+确保通过 `pip install lmdeploy[all]` 安装了 lmdeploy (>=v0.0.5)。
 
 如果安装之后，问题还存在，那么就把`libnccl.so.2`的路径加入到环境变量 LD_LIBRARY_PATH 中。
 

diff --git a/docs/zh_cn/supported_models/codellama.md b/docs/zh_cn/supported_models/codellama.md
@@ -26,7 +26,7 @@
 
 ```shell
 # 安装 lmdeploy
-python3 -m pip install lmdeploy
+python3 -m pip install lmdeploy[all]
 
 # 转模型格式
 python3 -m lmdeploy.serve.turbomind.deploy codellama /path/of/codellama/model

diff --git a/docs/zh_cn/w4a16.md b/docs/zh_cn/w4a16.md
@@ -5,7 +5,7 @@ LMDeploy 支持 4bit 权重模型的推理，**对 NVIDIA 显卡的最低要求
 在推理之前，请确保安装了 lmdeploy
 
 ```shell
-pip install lmdeploy
+pip install lmdeploy[all]
 ```
 
 ## 4bit 权重模型推理

diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,4 @@
 -r requirements/build.txt
 -r requirements/runtime.txt
--r requirements/optional.txt
+-r requirements/lite.txt
+-r requirements/serve.txt
diff --git a/requirements/lite.txt b/requirements/lite.txt
@@ -0,0 +1,2 @@
+accelerate
+datasets
diff --git a/requirements/optional.txt → requirements/serve.txt b/requirements/optional.txt → requirements/serve.txt
@@ -1,5 +1,3 @@
-accelerate
-datasets
 fastapi
 shortuuid
 uvicorn
diff --git a/setup.py b/setup.py
@@ -138,7 +138,8 @@ def gen_packages_items():
           install_requires=parse_requirements('requirements/runtime.txt'),
           extras_require={
               'all': parse_requirements('requirements.txt'),
-              'optional': parse_requirements('requirements/optional.txt'),
+              'lite': parse_requirements('requirements/lite.txt'),
+              'serve': parse_requirements('requirements/serve.txt'),
           },
           has_ext_modules=check_ext_modules,
           classifiers=[