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

[Minor] Change Arg Name: "--api_nproc" -> "--api-nproc" #750

Merged
merged 1 commit into from
Jan 24, 2025
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
2 changes: 1 addition & 1 deletion docs/en/EvalByLMDeploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ lmdeploy serve api_server OpenGVLab/InternVL2-8B --model-name InternVL2-8B
## Step 2: Evaluation

```bash
python run.py --data MMStar --model lmdeploy --verbose --api_nproc 64
python run.py --data MMStar --model lmdeploy --verbose --api-nproc 64
```
2 changes: 1 addition & 1 deletion docs/en/Quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ We use `run.py` for evaluation. To use the script, you can use `$VLMEvalKit/run.
- `--data (list[str])`: Set the dataset names that are supported in VLMEvalKit (names can be found in the codebase README).
- `--model (list[str])`: Set the VLM names that are supported in VLMEvalKit (defined in `supported_VLM` in `vlmeval/config.py`).
- `--mode (str, default to 'all', choices are ['all', 'infer'])`: When `mode` set to "all", will perform both inference and evaluation; when set to "infer", will only perform the inference.
- `--api_nproc (int, default to 4)`: The number of threads for OpenAI API calling.
- `--api-nproc (int, default to 4)`: The number of threads for OpenAI API calling.
- `--work-dir (str, default to '.')`: The directory to save evaluation results.

**Command for Evaluating Image Benchmarks **
Expand Down
2 changes: 1 addition & 1 deletion docs/zh-CN/EvalByLMDeploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ lmdeploy serve api_server OpenGVLab/InternVL2-8B --model-name InternVL2-8B
## 第2步 评测

```bash
python run.py --data MMStar --model InternVL2-8B --verbose --api_nproc 64
python run.py --data MMStar --model InternVL2-8B --verbose --api-nproc 64
```
2 changes: 1 addition & 1 deletion docs/zh-CN/Quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ pip install -e .
- `--data (list[str])`: 设置在 VLMEvalKit 中支持的数据集名称(可以在代码库首页的 README 中找到支持的数据集列表)
- `--model (list[str])`: 设置在 VLMEvalKit 中支持的 VLM 名称(在 `vlmeval/config.py` 中的 `supported_VLM` 中定义)
- `--mode (str, 默认值为 'all', 可选值为 ['all', 'infer'])`:当 mode 设置为 "all" 时,将执行推理和评估;当设置为 "infer" 时,只执行推理
- `--api_nproc (int, 默认值为 4)`: 调用 API 的线程数
- `--api-nproc (int, 默认值为 4)`: 调用 API 的线程数
- `--work-dir (str, default to '.')`: 存放测试结果的目录

**用于评测图像多模态评测集的命令**
Expand Down
Loading