annotation_zip visualize_annotation_count_by_attribute_value#

Description#

属性値ごとのアノテーション数をヒストグラムで可視化したHTMLファイルを出力します。

アノテーション数は、ダウンロードしたアノテーションZIPから算出します。

集計対象の属性の種類は以下の通りです。

  • ドロップダウン

  • ラジオボタン

  • チェックボックス

Examples#

基本的な使い方#

$ annofabcli annotation_zip visualize_annotation_count_by_attribute_value --project_id prj1 --output attributes_count.html

下図は attributes_count.html の中身です。ラベル名、属性名、属性値のペアごとにヒストグラムが描画されています。

attributes_count.htmlの中身

デフォルトではタスク単位でアノテーション数を集計します。入力データ単位に集計する場合は、 --group_by input_data_id を指定してください。

--annotation にアノテーションzipまたはzipを展開したディレクトリを指定できます。

$ annofabcli annotation_zip visualize_annotation_count_by_attribute_value --project_id prj1 --annotation annotation.zip --output attributes_count.html

ラベルで絞り込む#

--label_name を指定すると、指定したラベルに属する属性値だけを集計・描画します。 --attribute_name と併用すると、指定したラベルに属する指定属性の値だけが対象になります。 --additional_attribute_name と併用すると、指定したラベルに属するデフォルトの選択系属性に加えて、指定属性の値も対象になります。

$ annofabcli annotation_zip visualize_annotation_count_by_attribute_value --project_id prj1 \
  --label_name car --output car_attributes_count.html

ラベル名の指定方法は annotation_zip count_annotation_by_attribute_value と共通です。

入力データごとに可視化する#

$ annofabcli annotation_zip visualize_annotation_count_by_attribute_value --project_id prj1 --group_by input_data_id --output attributes_count.html

集計結果をCSV/JSONで出力したい場合は、 annotation_zip count_annotation_by_attribute_value を使用してください。

--bin_width の指定方法は ヒストグラムのビン幅 を参照してください。

Command line options#

属性値ごとのアノテーション数をヒストグラムで可視化します。

usage: annofabcli annotation_zip visualize_annotation_count_by_attribute_value
       [-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 [--group_by {task_id,input_data_id}] -o OUTPUT
       [--bin_width BIN_WIDTH] [--exclude_empty_value] [--arrange_bin_edge]
       [-tq TASK_QUERY] [-t TASK_ID [TASK_ID ...]] [--latest]
       [--temp_dir TEMP_DIR] [--use_japanese_name]
       [--additional_attribute_name ADDITIONAL_ATTRIBUTE_NAME [ADDITIONAL_ATTRIBUTE_NAME ...] |
       --attribute_name ATTRIBUTE_NAME [ATTRIBUTE_NAME ...]]
       [--label_name LABEL_NAME [LABEL_NAME ...]]

Named Arguments#

--annotation

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

-p, --project_id

対象のプロジェクトのproject_idを指定します。

--group_by

Possible choices: task_id, input_data_id

アノテーションの個数をどの単位で集約するかを指定します。

Default: 'task_id'

-o, --output

出力先HTMLファイルのパスを指定します。

--bin_width

ヒストグラムのビンの幅を1以上の整数で指定します。指定しない場合は、ビンの個数が20になるようにビンの幅が調整されます。

--exclude_empty_value

指定すると、すべてのタスクでアノテーション数が0であるヒストグラムを描画しません。

Default: False

--arrange_bin_edge

指定すると、ヒストグラムのデータの範囲とビンの幅がすべてのヒストグラムで一致します。

Default: False

-tq, --task_query

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

-t, --task_id

対象のタスクのtask_idを指定します。 file:// を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。ファイルを読み込む場合は、ファイル指定を1個だけ渡してください。直接指定するIDや別のファイル指定とは併用できません。

--latest

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

Default: False

--temp_dir

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

--use_japanese_name

ラベル名、属性名、選択肢名をアノテーション仕様に登録されている日本語名で出力します。日本語名がない場合は英語名を出力します。

Default: False

--additional_attribute_name

デフォルトで集計される選択肢系の属性（ドロップダウン、ラジオボタン、チェックボックス）に加えて、集計したい属性の英語名を指定します。ラベル名に関係なく、デフォルト属性と指定した属性名を持つ属性が集計対象になります。 file:// を先頭に付けると、属性名が記載されたファイルを指定できます。 ファイルを読み込む場合は、ファイル指定を1個だけ渡してください。直接指定する値や別のファイル指定とは併用できません。

--label_name

集計対象とするラベルの英語名を指定します。指定したラベルに属する属性値のみが集計対象になります。 file:// を先頭に付けると、ラベル名が記載されたファイルを指定できます。 ファイルを読み込む場合は、ファイル指定を1個だけ渡してください。直接指定する値や別のファイル指定とは併用できません。

--attribute_name

集計対象とする属性の英語名を指定します。指定した属性名のみが集計対象になります（デフォルトの選択肢系属性は含まれません）。ラベル名に関係なく、指定した属性名を持つ属性のみが集計対象になります。 file:// を先頭に付けると、属性名が記載されたファイルを指定できます。 ファイルを読み込む場合は、ファイル指定を1個だけ渡してください。直接指定する値や別のファイル指定とは併用できません。

common options (after the subcommand)#

--yes

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

Default: False

--endpoint_url

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

--annofab_user_id

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

--annofab_password

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

--annofab_pat

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

--logdir

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

Default: .log

--disable_log

ログを無効にします。

Default: False

--debug

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

Default: False

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