annotation_specs add_label

Description

アノテーション仕様にラベルを1件追加します。

Examples

基本的な使い方

$ annofabcli annotation_specs add_label \
 --project_id prj1 \
 --label_name_en pedestrian \
 --annotation_type bounding_box

色やlabel_idを明示する場合

$ annofabcli annotation_specs add_label \
 --project_id prj1 \
 --label_name_en road \
 --label_name_ja 路面 \
 --annotation_type segmentation_v2 \
 --label_id road_label \
 --color '#00CCFF'

field_values を指定して追加する場合

field_values.json

{
    "display_name": {
        "_type": "DisplayName",
        "text": "歩行者"
    }
}

$ annofabcli annotation_specs add_label \
 --project_id prj1 \
 --label_name_en pedestrian \
 --annotation_type bounding_box \
 --field_values_json file://field_values.json

field_values のフォーマットは、 annotation_specs update_label_field_values を参照してください。

--annotation_type の値

値	説明	使用できるプロジェクト
bounding_box	矩形	画像プロジェクト
segmentation	塗りつぶし（インスタンスセグメンテーション用）	画像プロジェクト
segmentation_v2	塗りつぶしv2（セマンティックセグメンテーション用）	画像プロジェクト
polygon	ポリゴン（閉じた頂点集合）	画像プロジェクト
polyline	ポリライン（開いた頂点集合）	画像プロジェクト
point	点	画像プロジェクト
classification	全体分類	画像プロジェクト、動画プロジェクト
range	動画の区間	動画プロジェクト
custom	カスタム	カスタムプロジェクト
user_bounding_box	3次元のバウンディングボックス	3次元プロジェクト
user_instance_segment	3次元のインスタンスセグメント	3次元プロジェクト
user_semantic_segment	3次元のセマンティックセグメント	3次元プロジェクト

Usage Details

アノテーション仕様にラベルを1件追加します。属性の紐付けは行いません。

usage: annofabcli annotation_specs add_label [-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] -p PROJECT_ID
                                             --label_name_en LABEL_NAME_EN
                                             --annotation_type
                                             {bounding_box,segmentation,segmentation_v2,polygon,polyline,point,classification,range,custom,user_bounding_box,user_instance_segment,user_semantic_segment}
                                             [--label_id LABEL_ID]
                                             [--label_name_ja LABEL_NAME_JA]
                                             [--color COLOR]
                                             [--field_values_json FIELD_VALUES_JSON]
                                             [--comment COMMENT]

Named Arguments

-p, --project_id

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

--label_name_en

追加するラベルの英語名。

--annotation_type

Possible choices: bounding_box, segmentation, segmentation_v2, polygon, polyline, point, classification, range, custom, user_bounding_box, user_instance_segment, user_semantic_segment

追加するラベルのアノテーション種類。

指定できる値:

• bounding_box : 矩形 [画像プロジェクト で使用可]

• segmentation : 塗りつぶし（インスタンスセグメンテーション用） [画像プロジェクト で使用可]

• segmentation_v2 : 塗りつぶしv2（セマンティックセグメンテーション用） [画像プロジェクト で使用可]

• polygon : ポリゴン（閉じた頂点集合） [画像プロジェクト で使用可]

• polyline : ポリライン（開いた頂点集合） [画像プロジェクト で使用可]

• point : 点 [画像プロジェクト で使用可]

• classification : 全体分類 [画像プロジェクト / 動画プロジェクト で使用可]

• range : 動画の区間 [動画プロジェクト で使用可]

• custom : カスタム [カスタムプロジェクト で使用可]

• user_bounding_box : 3次元のバウンディングボックス [3次元プロジェクト で使用可]

• user_instance_segment : 3次元のインスタンスセグメント [3次元プロジェクト で使用可]

• user_semantic_segment : 3次元のセマンティックセグメント [3次元プロジェクト で使用可]

--label_id

追加するラベルのlabel_id。未指定の場合はUUIDv4を自動生成します。

--label_name_ja

追加するラベルの日本語名。未指定の場合は英語名と同じ値を使用します。

--color

追加するラベルの色。 #RRGGBB 形式の16進数カラーコードを指定してください。未指定の場合は自動設定されます。

--field_values_json

追加するラベルに設定するfield_valuesのJSONオブジェクト。 file:// を先頭に付けるとJSONファイルを指定できます。 field_valuesのフォーマットはWebAPIの AnnotationTypeFieldValue を参照してください。

--comment

アノテーション仕様の変更内容を説明するコメント。未指定の場合、自動でコメントが生成されます。

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リクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。