Command line options¶
利用頻度が高いコマンドラインオプションを記載します。
リソースを指定するオプション¶
--organization / -org¶
組織名を指定します。
--project_id / -p¶
プロジェクトのproject_idを指定します。
--task_id / -t¶
タスクのtask_idを指定します。
--input_data_id / -i¶
入力データのinput_data_idを指定します。
--user_id / -u¶
ユーザのuser_idを指定します。
--job_id¶
ジョブのjob_idを指定します。
--job_type¶
ジョブの種類を指定します。 指定できる値は以下の通りです。
copy-project
: プロジェクトのコピーgen-inputs
: zipファイルから入力データの作成gen-tasks
: タスクの作成gen-annotation
: アノテーションZIPの更新gen-tasks-list
: タスク全件ファイルの更新gen-inputs-list
: 入力データ全件ファイルの更新delete-project
: プロジェクトの削除invoke-hook
: Webhookの起動move-project
: プロジェクトの所属組織の移動
リソースの検索条件を指定するオプション¶
--task_query / -tq¶
タスクを絞り込む条件をJSON形式で指定します。
特に指定がない限り、以下のキーが利用可能です。
task_id
: 指定した値をtask_idに含むタスク(大文字小文字を区別しない)phase
: 指定したフェーズに一致するタスクphase_stage
: 指定したフェーズステージに一致するタスクstatus
: 指定したステータスに一致するタスクuser_id
: 担当者のuser_idに一致するタスクaccount_id
: 担当者のaccount_idに一致するタスクno_user
:true
なら担当者が未割り当てのタスク
phase
に利用できる値は以下の通りです。
annotation
: 教師付フェーズinspection
: 検査フェーズacceptance
: 受入フェーズ
status
に利用できる値は以下の通りです。
not_started
: 未着手状態complete
: 完了状態on_hold
: 保留中状態break
: 休憩中状態working
: 作業中状態
# task_idに"sample"を含むタスク
{"task_id": "sample"}
# 教師付フェーズで未着手状態のタスク
{"phase": "annotation", "status":"not_started"}
# フェーズステージが"2"のタスク
{"phase_stage": 2}
# 担当者のuser_idが"alice"であるタスク
{"user_id": "alice"}
# 担当者のaccount_idが"12345678-abcd-1234-abcd-1234abcd5678"であるタスク
{"account_id": "12345678-abcd-1234-abcd-1234abcd5678"}
# 担当者が未割り当てのタスク
{"no_user": true}
--input_data_query / -iq¶
入力データを絞り込む条件をJSON形式で指定します。
特に指定がない限り、以下のキーが利用可能です。
input_data_id
: 指定した値をinput_data_idに含む入力データ(大文字小文字を区別しない)input_data_name
: 指定した値を入力データ名に含む入力データ(大文字小文字を区別しない)input_data_path
: 指定した値を入力データパスに含む入力データ(大文字小文字を区別する)
# input_data_idに"202004"を含む入力データ
{"input_data_id": "202004"}
# 入力データ名に"lenna.png"を含む入力データ
{"input_data_name": "lenna.png"}
# 入力データパスに"lenna.png"を含む入力データ
{"input_data_path": "lenna.png"}
--annotation_query / -aq¶
アノテーションを絞り込む条件をJSON形式で指定します。
以下のキーが利用可能です。
label
: 指定したラベル名(英語)に一致するアノテーション(必須)attributes
: 指定した属性の検索条件に一致するアノテーション
# ラベル名(英語)が"bike"のアノテーション
{"label": "bike"}
# ラベル名(英語)が"car"で、属性(英語名)"occluded"の値がtrueである(チェックボックス)アノテーション
{"label": "car", "attributes":{"occluded":true}}
# ラベル名(英語)が"car"で、属性(英語名)"count"の値が"1" AND 属性(英語名)"note"の値が"comment"であるアノテーション
{"label": "car", "attributes":{"count":1, "note":"comment"}}
# ラベル名(英語)が"car"で、属性(英語名)"weather"の選択肢名(英語)が"sunny"であるアノテーション
{"label": "car", "attributes":{"weather": "sunny"}}
パスを指定するオプション¶
--output / -o¶
出力先のファイルを指定します。
--output_dir / -o¶
出力先のディレクトリを指定します。
--csv¶
CSVファイルを指定します。
--dir¶
ディレクトリを指定します。
--backup¶
バックアップ情報の出力先ディレクトリを指定します。
--annotation¶
アノテーション情報が格納されたディレクトリ、またはzipファイルを指定します。
--task_json¶
タスク全件ファイルを指定します。
--task_history_json¶
タスク履歴全件ファイルを指定します。
--input_data_json¶
入力データ全件ファイルを指定します。
--inspection_comment_json¶
検査コメント全件ファイルを指定します。
その他のオプション¶
--force¶
強制的に変更/削除します。
--overwrite¶
上書きします。
--parallelism¶
並列数(同時に実行するプロセス数)を指定します。
--latest¶
アノテーションzipやタスク全件ファイルを最新化してから、それらのファイルを参照します。
--wait¶
処理が完了するまで待ちます。
--wait_options¶
ある処理が完了するまで待つ際のオプションを指定します。--latest
または --wait
と一緒に利用します。
以下のキーが利用可能です。
interval
: 処理が完了したかを確認する頻度[秒]max_tries
: 処理が完了したかを確認する回数の上限数
# 完了したかを300秒ごとに確認し、最大10回問い合わせます(50分間待つ)。
{"interval":300, "max_tries":10}