[Docs] Add cli usage to docs #4569
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for your contribution! |
xiaolei373
force-pushed
the
add_cli_docs
branch
2 times, most recently
from
e92b8e6 to
67c1ffc
Compare
sunlei1024
previously approved these changes
Oct 27, 2025
Jiang-Jia-Jun
requested changes
Oct 27, 2025
docs/cli/serve.md
Outdated
| |-|-|-| | ||
| |--config|从配置文件读取 CLI 选项（YAML 格式）|None| | ||
|
|
||
| 更多参数说明见：[FastDeploy 参数文档](https://github.com/PaddlePaddle/FastDeploy/blob/develop/docs/zh/parameters.md) |
Collaborator
There was a problem hiding this comment.
使用相对文件路径链接，不要使用这种纯链接
docs/cli/bench.md
Outdated
| ``` | ||
| # Run task evaluation on an online service | ||
| fastdeploy bench eval --model local-completions \ | ||
| --model_args pretrained=./baidu/ERNIE-4.5-0.3B-Paddle,base_url=http://0.0.0.0:8490/v1/completions,tokenizer=./baidu/ERNIE-4.5-0.3B-Paddle,trust_remote_code=True \ |
Collaborator
There was a problem hiding this comment.
我们应该没有支持trust_remote_code或者是tokenizer自定义（至少没测试过），所以文档建议不要写上
docs/cli/run-batch.md
Outdated
| | --output-tmp-dir | Temporary directory used to store the output file before uploading it to the output URL. | None | | ||
| | --model | Path to the model | None | | ||
|
|
||
| For more details on additional parameters, see the [FastDeploy Parameter Documentation](https://github.com/PaddlePaddle/FastDeploy/blob/develop/docs/en/parameters.md). |
docs/zh/cli/run-batch.md
Outdated
| |--output-tmp-dir|在将输出文件上传到输出 URL 之前，用于存放输出文件的临时目录。|None| | ||
| |--model|模型路径|None| | ||
|
|
||
| 更多参数说明见：[FastDeploy 参数文档](https://github.com/PaddlePaddle/FastDeploy/blob/develop/docs/zh/parameters.md) |
docs/zh/cli/serve.md
Outdated
| |-|-|-| | ||
| |--config|从配置文件读取 CLI 选项（YAML 格式）|None| | ||
|
|
||
| 更多参数说明见：[FastDeploy 参数文档](https://github.com/PaddlePaddle/FastDeploy/blob/develop/docs/zh/parameters.md) |
xiaolei373
force-pushed
the
add_cli_docs
branch
from
67c1ffc to
fbaf5e2
Compare
xiaolei373
force-pushed
the
add_cli_docs
branch
from
fbaf5e2 to
83ccd9f
Compare
Jiang-Jia-Jun
approved these changes
Oct 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
添加CLI命令行工具说明文档
Modifications
Usage or Command
Accuracy Tests
Checklist
[FDConfig],[APIServer],[Engine],[Scheduler],[PD Disaggregation],[Executor],[Graph Optimization],[Speculative Decoding],[RL],[Models],[Quantization],[Loader],[OP],[KVCache],[DataProcessor],[BugFix],[Docs],[CI],[Optimization],[Feature],[Benchmark],[Others],[XPU],[HPU],[GCU],[DCU],[Iluvatar],[Metax]]pre-commitbefore commit.releasebranch, make sure the PR has been submitted to thedevelopbranch, then cherry-pick it to thereleasebranch with the[Cherry-Pick]PR tag.