annofabcli 1.111.0__tar.gz → 1.111.1__tar.gz

{annofabcli-1.111.0 → annofabcli-1.111.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: annofabcli
-Version: 1.111.0
+Version: 1.111.1
 Summary: Utility Command Line Interface for AnnoFab
 Author: Kurusugawa Computer Inc.
 License: MIT

{annofabcli-1.111.0 → annofabcli-1.111.1}/annofabcli/annotation/import_annotation.py

@@ -254,8 +254,8 @@ class AnnotationConverter:
         for attribute_name, attribute_value in attributes.items():
             try:
                 specs_additional_data = self.annotation_specs_accessor.get_attribute(attribute_name=attribute_name, label=label)
-            except ValueError:
-                logger.warning(f"アノテーション仕様に属性名(英語)が'{attribute_name}'である属性情報が存在しないか、複数存在します。 :: {log_message_suffix}")
+            except ValueError as e:
+                logger.warning(f"アノテーション仕様に属性名(英語)が'{attribute_name}'である属性情報が存在しないか、複数存在します。 :: {log_message_suffix} :: error={e}")
                 if self.is_strict:
                     raise
                 continue
@@ -298,12 +298,11 @@ class AnnotationConverter:
             ValueError: 存在しないラベル名が指定された場合（`self.is_strict`がFalseでもraiseされる９
 
         """
-        log_message_suffix = f"task_id='{parser.task_id}', input_data_id='{parser.input_data_id}', label_name='{detail.label}', annotation_id='{detail.annotation_id}'"
 
         try:
             label_info = self.annotation_specs_accessor.get_label(label_name=detail.label)
-        except ValueError:
-            logger.warning(f"アノテーション仕様にラベル名(英語)が'{detail.label}'であるラベル情報が存在しないか、または複数存在します。 :: {log_message_suffix}")
+        except ValueError as e:
+            logger.warning(f"アノテーション仕様にラベル名(英語)が'{detail.label}'であるラベル情報が存在しないか、または複数存在します。 :: {log_message_suffix} :: error={e}")
             raise
 
         if detail.attributes is not None:
@@ -361,9 +360,12 @@ class AnnotationConverter:
             old_dict_detail[old_detail["annotation_id"]] = old_detail
 
         new_request_details: list[dict[str, Any]] = []
-        for detail in details:
+        for detail_index, detail in enumerate(details):
             try:
-                log_message_suffix = f"task_id='{parser.task_id}', input_data_id='{parser.input_data_id}', label_name='{detail.label}', annotation_id='{detail.annotation_id}'"
+                # detail_indexを出力する理由: annotation_idはNoneだとどれが問題なのか分からないため
+                log_message_suffix = (
+                    f"task_id='{parser.task_id}', input_data_id='{parser.input_data_id}', label_name='{detail.label}', annotation_id='{detail.annotation_id}', detail_index={detail_index}"
+                )
 
                 request_detail = self.convert_annotation_detail(parser, detail, log_message_suffix=log_message_suffix)
             except Exception as e:

{annofabcli-1.111.0 → annofabcli-1.111.1}/annofabcli/statistics/visualization/dataframe/whole_productivity_per_date.py

@@ -141,7 +141,7 @@ class WholeProductivityPerCompletedDate:
         return pandas.DataFrame(index=[e.strftime("%Y-%m-%d") for e in pandas.date_range(start_date, end_date)])
 
     @classmethod
-    def from_df_wrapper(cls, task: Task, worktime_per_date: WorktimePerDate, task_completion_criteria: TaskCompletionCriteria) -> WholeProductivityPerCompletedDate:
+    def from_df_wrapper(cls, task: Task, worktime_per_date: WorktimePerDate, task_completion_criteria: TaskCompletionCriteria) -> WholeProductivityPerCompletedDate:  # noqa: PLR0912
         """
         完了日毎の全体の生産量、生産性を算出する。
 
@@ -172,6 +172,8 @@ class WholeProductivityPerCompletedDate:
             datetime_column = "first_acceptance_reached_datetime"
         elif task_completion_criteria == TaskCompletionCriteria.INSPECTION_REACHED:
             datetime_column = "first_inspection_reached_datetime"
+        elif task_completion_criteria == TaskCompletionCriteria.ANNOTATION_STARTED:
+            datetime_column = "first_annotation_started_datetime"
         else:
             assert_noreturn(task_completion_criteria)
 
@@ -280,6 +282,8 @@ class WholeProductivityPerCompletedDate:
             str_task = "受入フェーズに到達した"
         elif self.task_completion_criteria == TaskCompletionCriteria.INSPECTION_REACHED:
             str_task = "検査フェーズに到達した"
+        elif self.task_completion_criteria == TaskCompletionCriteria.ANNOTATION_STARTED:
+            str_task = "教師付フェーズが着手された"
         else:
             assert_noreturn(self.task_completion_criteria)
 
@@ -884,6 +888,9 @@ class WholeProductivityPerFirstAnnotationStartedDate:
             df_sub_task = df_task[df_task["phase"] == TaskPhase.ACCEPTANCE.value]
         elif task_completion_criteria == TaskCompletionCriteria.INSPECTION_REACHED:
             df_sub_task = df_task[df_task["phase"].isin([TaskPhase.INSPECTION.value, TaskPhase.ACCEPTANCE.value])]
+        elif task_completion_criteria == TaskCompletionCriteria.ANNOTATION_STARTED:
+            # 教師付フェーズが着手されたタスク（first_annotation_started_datetimeがNoneでない）を抽出する
+            df_sub_task = df_task[df_task["first_annotation_started_datetime"].notna()]
         else:
             assert_noreturn(task_completion_criteria)
 
@@ -1013,6 +1020,8 @@ class WholeProductivityPerFirstAnnotationStartedDate:
                 str_task = "受入フェーズ"
             elif self.task_completion_criteria == TaskCompletionCriteria.INSPECTION_REACHED:
                 str_task = "検査フェーズまたは受入フェーズ"
+            elif self.task_completion_criteria == TaskCompletionCriteria.ANNOTATION_STARTED:
+                str_task = "教師付フェーズが着手されたタスク"
             else:
                 assert_noreturn(self.task_completion_criteria)
 

{annofabcli-1.111.0 → annofabcli-1.111.1}/annofabcli/statistics/visualization/model.py

@@ -40,6 +40,8 @@ class TaskCompletionCriteria(Enum):
     """タスクが受入フェーズに到達したら「タスクの完了」とみなす"""
     INSPECTION_REACHED = "inspection_reached"
     """タスクが検査フェーズに到達したら「タスクの完了」とみなす"""
+    ANNOTATION_STARTED = "annotation_started"
+    """教師付フェーズが着手されたら「タスクの完了」とみなす"""
 
     def is_task_completed(self, task: dict[str, Any]) -> bool:
         """指定したタスクが、タスクの完了条件に合致するかどうかを判定します。
@@ -48,6 +50,7 @@ class TaskCompletionCriteria(Enum):
             task: タスク情報。以下のキーを参照します。
                 * phase
                 * status
+                * work_time_span (ANNOTATION_STARTEDの場合のみ)
 
         Returns:
             タスクの完了条件に合致する場合はTrue、そうでない場合はFalse
@@ -62,5 +65,10 @@ class TaskCompletionCriteria(Enum):
             # 受入フェーズも含む理由：検査フェーズに到達したタスクを「完了」とみなすならば、検査フェーズより後段フェーズである受入フェーズも「完了」とみなせるため
             return task["phase"] in {TaskPhase.INSPECTION.value, TaskPhase.ACCEPTANCE.value}
 
+        elif self == TaskCompletionCriteria.ANNOTATION_STARTED:
+            # 教師付フェーズが着手されたタスクを「完了」とみなす
+            # work_time_span > 0 であれば教師付フェーズが着手されたとみなす
+            return task["work_time_span"] > 0
+
         else:
             assert_noreturn(self)

{annofabcli-1.111.0 → annofabcli-1.111.1}/annofabcli/statistics/visualization/project_dir.py

@@ -42,7 +42,7 @@ class ProjectDir(DataClassJsonMixin):
         - acceptance_completed: 受入フェーズの完了状態
         - acceptance_reached: 受入フェーズに到達
         - inspection_reached: 検査フェーズまたは受入フェーズに到達
-        - annotation_started: 教師付フェーズを着手
+        - annotation_started: 教師付フェーズが着手された
     """
 
     FILENAME_WHOLE_PERFORMANCE = "全体の生産性と品質.csv"

{annofabcli-1.111.0 → annofabcli-1.111.1}/annofabcli/statistics/visualize_statistics.py

@@ -710,7 +710,9 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
         default=TaskCompletionCriteria.ACCEPTANCE_COMPLETED.value,
         help="タスクの完了条件を指定します。\n"
         "* ``acceptance_completed``: タスクが受入フェーズの完了状態であれば「タスクの完了」とみなす\n"
-        "* ``acceptance_reached``: タスクが受入フェーズに到達したら「タスクの完了」とみなす\n",
+        "* ``acceptance_reached``: タスクが受入フェーズに到達したら「タスクの完了」とみなす\n"
+        "* ``inspection_reached``: タスクが検査フェーズに到達したら「タスクの完了」とみなす\n"
+        "* ``annotation_started``: 教師付フェーズが着手されたら「タスクの完了」とみなす\n",
     )
 
     parser.add_argument(

{annofabcli-1.111.0 → annofabcli-1.111.1}/docs/command_reference/input_data/put.rst

@@ -87,7 +87,6 @@ JSON文字列を指定する場合
             "input_data_name":"data2",
             "input_data_path":"s3://example.com/data2",
             "input_data_id":"id2",
-            "sign_required": false
         }
     ]
 

{annofabcli-1.111.0 → annofabcli-1.111.1}/docs/command_reference/statistics/visualize.rst

@@ -80,6 +80,19 @@ Examples
 ``acceptance_reached`` と同様な理由で、検査フェーズと受入フェーズの作業時間と生産量は0になります。
 
 
+``annotation_started``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``annotation_started`` を指定すると、教師付フェーズが着手されたタスクを「生産したタスク（作業が完了したタスク）」とみなして、教師付フェーズが着手されたタスクを集計対象にします。
+このオプションは、未完了のタスクが多いときに有用です。たとえば以下のようなケースです。
+
+* アノテーションルールに不明瞭な部分があるため、タスクを提出することができず、教師付フェーズ保留状態のタスクが大量にある。これらのタスクは未完了だがほとんど完了しているため、生産性の評価対象タスクに加えたい。
+* アノテーション作業の終盤でアノテーションルールが変わったため、大量の受入フェーズ完了状態のタスクを教師付フェーズに差し戻した。これらのタスクは未完了だがほとんど完了しているため、生産性の評価対象タスクに加えたい。
+
+``acceptance_reached`` や ``inspection_reached`` とは異なり、 ``annotation_started`` では検査/受入フェーズの生産量と作業時間は0になりません。
+``annotation_started`` を指定するときは、「検査/受入フェーズをアノテーションチーム以外が作業する」とは限らないためです。
+
+
 
 実績作業時間情報から生産性を算出する
 ----------------------------------------------
@@ -195,7 +208,7 @@ CSVには以下の列が存在している必要があります。
 デフォルトでは、入力データ数とアノテーション数を生産量としています。しかし、この生産量はプロジェクトによっては適切でない場合があります。
 たとえば、動画プロジェクトでは動画時間が生産量として適切かもしれません。また、セマンティックセグメンテーションプロジェクトでは塗りつぶしの面積や輪郭線の方が生産量として適切かもしれません。
 
-``--custom_project_volume`` に以下のようなJSON文字列を指定することで、入力データ数とアノテーション数以外の生産量を指定することができます。
+``--custom_production_volume`` に以下のようなJSON文字列を指定することで、入力データ数とアノテーション数以外の生産量を指定することができます。
 
 .. code-block:: json
 

{annofabcli-1.111.0 → annofabcli-1.111.1}/tests/statistics/visualization/test_model.py

@@ -56,6 +56,32 @@ from annofabcli.statistics.visualization.model import TaskCompletionCriteria
             TaskCompletionCriteria.INSPECTION_REACHED,
             False,
         ),
+        # ANNOTATION_STARTED
+        (
+            {"phase": TaskPhase.ANNOTATION.value, "status": TaskStatus.WORKING.value, "work_time_span": 1},
+            TaskCompletionCriteria.ANNOTATION_STARTED,
+            True,
+        ),
+        (
+            {"phase": TaskPhase.INSPECTION.value, "status": TaskStatus.COMPLETE.value, "work_time_span": 10},
+            TaskCompletionCriteria.ANNOTATION_STARTED,
+            True,
+        ),
+        (
+            {"phase": TaskPhase.ACCEPTANCE.value, "status": TaskStatus.COMPLETE.value, "work_time_span": 100},
+            TaskCompletionCriteria.ANNOTATION_STARTED,
+            True,
+        ),
+        (
+            {"phase": TaskPhase.ANNOTATION.value, "status": TaskStatus.NOT_STARTED.value, "work_time_span": 0},
+            TaskCompletionCriteria.ANNOTATION_STARTED,
+            False,
+        ),
+        (
+            {"phase": TaskPhase.ANNOTATION.value, "status": TaskStatus.BREAK.value, "work_time_span": 0},
+            TaskCompletionCriteria.ANNOTATION_STARTED,
+            False,
+        ),
     ],
 )
 def test_is_task_completed(task, criteria, expected):