Arkindex CLI客户端易于使用
arkindex-cli的Python项目详细描述
Arkindex命令行
Arkindex CLI允许您对Arkindex执行各种高级操作 实例。它既可以交互使用,也可以用于脚本编写。
您可以使用pip安装此工具:pip install arkindex-cli
要从命令行获取有关CLI的一般帮助,请使用arkindex -h
。
要获取子命令的特定帮助,请使用arkindex <subcommand> -h
。
登录
要与Arkindex实例交互,首先需要使用 电子邮件和密码。为此,请使用以下命令:
arkindex login
您将被要求提供实例URL、电子邮件和密码。 如果你用化名的话 应存储凭据,以及这些凭据是否应为默认值 用于所有其他命令的凭据。
然后,凭证存储在位于的YAML文件中
~/.config/arkindex/cli.yaml
。您的电子邮件和密码不会直接存储;
只有实例URL和API令牌。
在任何子命令中,可以使用-p
或--profile
参数选择
默认配置文件以外的配置文件。例如,如果您登录到两个
使用别名Foo
和Bar
的实例,默认实例是
Foo
,默认情况下,所有arkindex
命令都将登录到Foo
,并且您可以
使用arkindex --profile Bar <subcommand>
连接到Bar
。
熔融指数报告
Arkindex机器学习工作者可以返回ml_report.json
工件;JSON
描述工作进程处理的元素以及创建的
元素、分类或转录以及遇到的错误。
CLI可以获取进程的所有ML报告并提供统计信息 关于错误:
^{pr2}$可能的输出可能是:
11061 elements: 10575 successful, 486 with errors
Errors by class
┏━━━━━━━━━━━━━┳━━━━━━━┓
┃ Class ┃ Count ┃
┡━━━━━━━━━━━━━╇━━━━━━━┩
│ HTTPError │ 470 │
│ KeyError │ 15 │
│ ReadTimeout │ 1 │
└─────────────┴───────┘
默认情况下,此命令检索最近运行的
过程。如果要使用其他管路,可以使用指定其编号
-r
或{
arkindex process report <Process ID> --run 4
输出模式
JSON模式可用于-j
或--json
参数。
这将返回一个对象,其中包含
至少有一个错误。
您还可以显示完整的错误消息和语法回溯
使用-v
或--verbose
突出显示。
工艺恢复
可以在另一个进程的失败元素上启动新进程 (至少有一个错误的元素):
arkindex process recover <Process ID>
这将检索ML报告,列出失败的元素,并将它们添加到 您的选择,然后创建一个未配置的进程。将提供链接 打开Arkindex前端,允许您配置和启动 你的新流程。
因为这会更新您的选择,如果您已经选择了元素,则 工具将在取消选择它们之前要求您确认。
默认情况下,此命令从
进程的最新运行。如果要使用另一个管路,可以指定其
使用-r
或--run
进行编号:
arkindex process recover <Process ID> --run 4
班级管理
您可以构建一个CSV文件,列出来自语料库的所有ML类:
arkindex classes --init my_classes.csv <corpus_id>
文件my_classes.csv
将为找到的每个类有两列(ID和类名)。
- 项目
标签: