statistics list_annotation_attribute#

Description#

アノテーションZIPを読み込み、アノテーションの属性値の一覧を出力します。

Examples#

JSON出力#

$ annofabcli statistics list_annotation_attribute --project_id prj1 \
 --output out.json --format pretty_json

out.json#

[
{
    "task_id": "task1",
    "task_status": "not_started",
    "task_phase": "annotation",
    "task_phase_stage": 1,
    "input_data_id": "input_data1",
    "input_data_name": "input_data1",
    "annotation_id": "7c113d44-d927-4457-a1c5-45ba6e34bbc4",
    "label": "car",
    "attributes": {
        "occluded": true,
        "type": "sedan"
    }
}
]

CSV出力#

$ annofabcli statistics list_annotation_attribute --project_id prj1 \
 --output out.csv --format csv

out.csv#
task_id	task_status	task_phase	task_phase_stage	input_data_id	input_data_name	annotation_id	label	attributes.occluded	attributes.type
task1	not_started	inspection	1	input_data1	input_data1	annotation1	car	true	sedan

Usage Details#

アノテーションZIPを読み込み、アノテーションの属性値の一覧を出力します。

usage: annofabcli statistics list_annotation_attribute [-h] [--yes]
                                                       [--endpoint_url ENDPOINT_URL]
                                                       [--annofab_user_id ANNOFAB_USER_ID]
                                                       [--annofab_password ANNOFAB_PASSWORD]
                                                       [--annofab_pat ANNOFAB_PAT]
                                                       [--logdir LOGDIR]
                                                       [--disable_log]
                                                       [--debug]
                                                       (--annotation ANNOTATION | -p PROJECT_ID)
                                                       [-f {csv,json,pretty_json}]
                                                       [-o OUTPUT]
                                                       [-tq TASK_QUERY]
                                                       [-t TASK_ID [TASK_ID ...]]
                                                       [--label_name LABEL_NAME [LABEL_NAME ...]]
                                                       [--latest]
                                                       [--temp_dir TEMP_DIR]

Named Arguments#

--annotation

アノテーションzip、またはzipを展開したディレクトリを指定します。指定しない場合はAnnofabからダウンロードします。

-p, --project_id

対象プロジェクトの project_id

-f, --format

Possible choices: csv, json, pretty_json

出力フォーマットを指定します。

Default: 'csv'

-o, --output

出力先のファイルパスを指定します。未指定の場合は、標準出力に出力されます。

-tq, --task_query

集計対象タスクを絞り込むためのクエリ条件をJSON形式で指定します。使用できるキーは task_id, status, phase, phase_stage です。 file:// を先頭に付けると、JSON形式のファイルを指定できます。

-t, --task_id

対象のタスクのtask_idを指定します。 file:// を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。

--label_name

出力対象のアノテーションのラベル名(英語)を指定します。指定しない場合はラベル名で絞り込みません。 file:// を先頭に付けると、ラベル名の一覧が記載されたファイルを指定できます。

--latest

--annotation を指定しないとき、最新のアノテーションzipを参照します。このオプションを指定すると、アノテーションzipを更新するのに数分待ちます。

--temp_dir

指定したディレクトリに、アノテーションZIPなどの一時ファイルをダウンロードします。

global optional arguments#

--yes

処理中に現れる問い合わせに対して、常に yes と回答します。

--endpoint_url

Annofab WebAPIのエンドポイントを指定します。

Default: 'https://annofab.com'

--annofab_user_id

Annofabにログインする際のユーザーID

--annofab_password

Annofabにログインする際のパスワード

--annofab_pat

Annofabにログインする際のパーソナルアクセストークン

--logdir

ログファイルを保存するディレクトリを指定します。

Default: .log

--disable_log

ログを無効にします。

--debug

HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。

オーナロールまたはアノテーションユーザロールを持つユーザで実行してください。