使用说明
注意:本文档已下线,内容不再更新,如需使用千帆ModelBuilder命令行CLI工具,请查看命令行CLI工具介绍。
功能介绍
千帆ModelBuilder提供了命令行CLI工具,方便在命令行中直接使用相关功能。命令行CLI工具支持推理服务相关和平台功能相关调用,本文主要介绍了平台功能相关调用说明。
- 平台功能相关:dataSet数据集、trainer训练、evaluation评估、plugin插件应用
安装CLI
安装Python SDK后,即可使用命令行CLI工具。安装命令如下:
pip install qianfan
鉴权
注意:在使用CLI工具前,需先配置鉴权相关信息。
使用前需要配置鉴权相关信息,如何获取 Access Key 和 Secret Key 值,请参考如何获取AK/SK。
配置鉴权如下所示。
export QIANFAN_ACCESS_KEY=your-access-key
export QIANFAN_SECRET_KEY=your-secret-key
使用CLI工具
配置鉴权相关信息后,通过以下命令使用命令行Client CLI工具,更多命令请参考命令列表,详见https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/cli.md。
qianfan [OPTIONS] <COMMAND> [ARGS]...
# 例如:
# qianfan --version
# qianfan --help
基础参数OPTIONS
注意:基础参数必须在 command 命令之前,否则会被识别成命令参数无法生效。
参数 | 描述 |
---|---|
--access-key TEXT |
百度智能云安全认证 Access Key。获取方式参考文档 |
--secret-key TEXT |
百度智能云安全认证 Secret Key。获取方式参考文档 |
--enable-traceback |
打印完整的错误堆栈信息,仅在发生异常时有效。 |
--version -v |
打印版本信息。 |
--install-shell-autocomplete |
为当前 shell 安装自动补全脚本。 |
--show-shell-autocomplete |
展示自动补全脚本。 |
--help -h |
打印帮助文档。 |
命令COMMAND
支持的COMMAND命令列表如下,更多命令使用请参考https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/cli.md
命令 | 类别 | 描述 |
---|---|---|
dataset | 数据集 | 用于训练和测试模型的数据集,通常包含多个样本和标签,用于机器学习和深度学习任务。 |
trainer | 训练trainer | 支持对数据集进行自定义训练。 |
evaluation | 评估 | 运行评估任务。 |
plugin | 插件应用 | 插件相关。 |
plugin插件应用
更多介绍查看plugin 插件使用文档,详见https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/cli.md#plugin-插件。
qianfan dataset [OPTIONS] <COMMAND>
# 例如
# qianfan plugin [OPTIONS]
dataset数据集
更多介绍查看dataset 数据集使用文档,详见https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/cli.md#dataset-数据集。
qianfan dataset [OPTIONS] <COMMAND>
# 例如
# qianfan dataset view 46685
trainer训练
更多介绍查看trainer训练使用文档,详见https://github.com/baidubce/bce-qianfan-sdk/blob/main/docs/cli.md#trainer-训练。
qianfan trainer [OPTIONS] COMMAND [ARGS]...