Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions annofabapi/dataclass/annotation.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class Point(DataClassJsonMixin):

@dataclass
class FullAnnotationDataClassification(DataClassJsonMixin):
""""""
""" """

type: str
"""Classification"""
Expand All @@ -65,7 +65,7 @@ class FullAnnotationDataSegmentation(DataClassJsonMixin):

@dataclass
class FullAnnotationDataSegmentationV2(DataClassJsonMixin):
""""""
""" """

data_uri: str
""""""
Expand Down Expand Up @@ -134,7 +134,7 @@ class FullAnnotationDataRange(DataClassJsonMixin):

@dataclass
class AdditionalData(DataClassJsonMixin):
""""""
""" """

additional_data_definition_id: str
""""""
Expand All @@ -154,7 +154,7 @@ class AdditionalData(DataClassJsonMixin):

@dataclass
class FullAnnotationAdditionalData(DataClassJsonMixin):
""""""
""" """

additional_data_definition_id: Optional[str]
""""""
Expand All @@ -171,7 +171,7 @@ class FullAnnotationAdditionalData(DataClassJsonMixin):

@dataclass
class FullAnnotationDetail(DataClassJsonMixin):
""""""
""" """

annotation_id: Optional[str]
"""アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID)<br> annotation_type が classification の場合は label_id と同じ値が格納されます。 """
Expand Down Expand Up @@ -200,7 +200,7 @@ class FullAnnotationDetail(DataClassJsonMixin):

@dataclass
class FullAnnotation(DataClassJsonMixin):
""""""
""" """

project_id: Optional[str]
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
Expand Down Expand Up @@ -235,7 +235,7 @@ class FullAnnotation(DataClassJsonMixin):

@dataclass
class SimpleAnnotationDetail(DataClassJsonMixin):
""""""
""" """

label: str
"""アノテーション仕様のラベル名です。 """
Expand All @@ -252,7 +252,7 @@ class SimpleAnnotationDetail(DataClassJsonMixin):

@dataclass
class SimpleAnnotation(DataClassJsonMixin):
""""""
""" """

annotation_format_version: str
"""アノテーションフォーマットのバージョンです。 アノテーションフォーマットとは、プロジェクト個別のアノテーション仕様ではなく、AnnoFabのアノテーション構造のことです。 したがって、アノテーション仕様を更新しても、このバージョンは変化しません。 バージョンの読み方と更新ルールは、業界慣習の[Semantic Versioning](https://semver.org/)にもとづきます。 JSONに出力されるアノテーションフォーマットのバージョンは、アノテーションZIPが作成される時点のものが使われます。 すなわち、`1.0.0`の時点のタスクで作成したアノテーションであっても、フォーマットが `1.0.1` に上がった次のZIP作成時では `1.0.1` となります。 バージョンを固定してZIPを残しておきたい場合は、プロジェクトが完了した時点でZIPをダウンロードして保管しておくか、またはプロジェクトを「停止中」にします。 """
Expand Down Expand Up @@ -287,7 +287,7 @@ class SimpleAnnotation(DataClassJsonMixin):

@dataclass
class SingleAnnotationDetail(DataClassJsonMixin):
""""""
""" """

annotation_id: str
"""アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID)<br> annotation_type が classification の場合は label_id と同じ値が格納されます。 """
Expand Down Expand Up @@ -322,7 +322,7 @@ class SingleAnnotationDetail(DataClassJsonMixin):

@dataclass
class SingleAnnotation(DataClassJsonMixin):
""""""
""" """

project_id: str
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
Expand All @@ -342,7 +342,7 @@ class SingleAnnotation(DataClassJsonMixin):

@dataclass
class AnnotationDetail(DataClassJsonMixin):
""""""
""" """

annotation_id: str
"""アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID)<br> annotation_type が classification の場合は label_id と同じ値が格納されます。 """
Expand Down Expand Up @@ -383,7 +383,7 @@ class AnnotationDetail(DataClassJsonMixin):

@dataclass
class Annotation(DataClassJsonMixin):
""""""
""" """

project_id: str
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
Expand Down
34 changes: 17 additions & 17 deletions annofabapi/dataclass/annotation_specs.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

@dataclass
class Keybind(DataClassJsonMixin):
""""""
""" """

code: str
""""""
Expand Down Expand Up @@ -56,7 +56,7 @@ class PositionForMinimumBoundingBoxInsertion(DataClassJsonMixin):

@dataclass
class LabelV1BoundingBoxMetadata(DataClassJsonMixin):
""""""
""" """

min_width: int
""""""
Expand Down Expand Up @@ -88,7 +88,7 @@ class LabelV1BoundingBoxMetadata(DataClassJsonMixin):

@dataclass
class LabelV1SegmentationMetadata(DataClassJsonMixin):
""""""
""" """

min_width: int
""""""
Expand All @@ -105,7 +105,7 @@ class LabelV1SegmentationMetadata(DataClassJsonMixin):

@dataclass
class InternationalizationMessageMessages(DataClassJsonMixin):
""""""
""" """

lang: str
""""""
Expand All @@ -116,7 +116,7 @@ class InternationalizationMessageMessages(DataClassJsonMixin):

@dataclass
class InternationalizationMessage(DataClassJsonMixin):
""""""
""" """

messages: List[InternationalizationMessageMessages]
""""""
Expand All @@ -127,7 +127,7 @@ class InternationalizationMessage(DataClassJsonMixin):

@dataclass
class InspectionPhrase(DataClassJsonMixin):
""""""
""" """

id: str
""""""
Expand All @@ -138,7 +138,7 @@ class InspectionPhrase(DataClassJsonMixin):

@dataclass
class AnnotationSpecsHistory(DataClassJsonMixin):
""""""
""" """

history_id: str
""""""
Expand All @@ -161,7 +161,7 @@ class AnnotationSpecsHistory(DataClassJsonMixin):

@dataclass
class Color(DataClassJsonMixin):
""""""
""" """

red: int
""""""
Expand All @@ -175,7 +175,7 @@ class Color(DataClassJsonMixin):

@dataclass
class AdditionalDataDefinitionV1Choices(DataClassJsonMixin):
""""""
""" """

choice_id: str
""""""
Expand All @@ -189,7 +189,7 @@ class AdditionalDataDefinitionV1Choices(DataClassJsonMixin):

@dataclass
class AdditionalDataDefinitionV1(DataClassJsonMixin):
""""""
""" """

additional_data_definition_id: str
""""""
Expand Down Expand Up @@ -227,7 +227,7 @@ class AdditionalDataDefinitionV1(DataClassJsonMixin):

@dataclass
class AdditionalDataDefinitionV2(DataClassJsonMixin):
""""""
""" """

additional_data_definition_id: str
""""""
Expand Down Expand Up @@ -256,7 +256,7 @@ class AdditionalDataDefinitionV2(DataClassJsonMixin):

@dataclass
class AnnotationEditorFeature(DataClassJsonMixin):
""""""
""" """

append: bool
""""""
Expand All @@ -279,7 +279,7 @@ class AnnotationEditorFeature(DataClassJsonMixin):

@dataclass
class LabelV1(DataClassJsonMixin):
""""""
""" """

label_id: str
""""""
Expand Down Expand Up @@ -317,7 +317,7 @@ class LabelV1(DataClassJsonMixin):

@dataclass
class LabelV2(DataClassJsonMixin):
""""""
""" """

label_id: str
""""""
Expand Down Expand Up @@ -355,7 +355,7 @@ class LabelV2(DataClassJsonMixin):

@dataclass
class AdditionalDataRestriction(DataClassJsonMixin):
""""""
""" """

additional_data_definition_id: str
""""""
Expand All @@ -366,7 +366,7 @@ class AdditionalDataRestriction(DataClassJsonMixin):

@dataclass
class AnnotationSpecsV1(DataClassJsonMixin):
""""""
""" """

project_id: str
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
Expand All @@ -389,7 +389,7 @@ class AnnotationSpecsV1(DataClassJsonMixin):

@dataclass
class AnnotationSpecsV2(DataClassJsonMixin):
""""""
""" """

project_id: str
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
Expand Down
2 changes: 1 addition & 1 deletion annofabapi/dataclass/input.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

@dataclass
class Resolution(DataClassJsonMixin):
""""""
""" """

width: float
""""""
Expand Down
6 changes: 3 additions & 3 deletions annofabapi/dataclass/instruction.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

@dataclass
class Instruction(DataClassJsonMixin):
""""""
""" """

html: Optional[str]
"""作業ガイドのHTML"""
Expand All @@ -29,7 +29,7 @@ class Instruction(DataClassJsonMixin):

@dataclass
class InstructionHistory(DataClassJsonMixin):
""""""
""" """

history_id: str
"""作業ガイドの履歴ID"""
Expand All @@ -43,7 +43,7 @@ class InstructionHistory(DataClassJsonMixin):

@dataclass
class InstructionImage(DataClassJsonMixin):
""""""
""" """

image_id: str
"""作業ガイド画像ID"""
Expand Down
2 changes: 1 addition & 1 deletion annofabapi/dataclass/job.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

@dataclass
class JobInfo(DataClassJsonMixin):
""""""
""" """

project_id: Optional[str]
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
Expand Down
4 changes: 2 additions & 2 deletions annofabapi/dataclass/my.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

@dataclass
class MyOrganization(DataClassJsonMixin):
""""""
""" """

organization_id: Optional[str]
"""組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
Expand Down Expand Up @@ -52,7 +52,7 @@ class MyOrganization(DataClassJsonMixin):

@dataclass
class MyAccount(DataClassJsonMixin):
""""""
""" """

account_id: str
""""""
Expand Down
4 changes: 2 additions & 2 deletions annofabapi/dataclass/organization.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

@dataclass
class OrganizationActivity(DataClassJsonMixin):
""""""
""" """

organization_id: str
"""組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
Expand All @@ -34,7 +34,7 @@ class OrganizationActivity(DataClassJsonMixin):

@dataclass
class Organization(DataClassJsonMixin):
""""""
""" """

organization_id: str
"""組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
Expand Down
2 changes: 1 addition & 1 deletion annofabapi/dataclass/organization_member.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

@dataclass
class OrganizationMember(DataClassJsonMixin):
""""""
""" """

organization_id: str
"""組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
Expand Down
6 changes: 3 additions & 3 deletions annofabapi/dataclass/project.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@

@dataclass
class ProjectSummary(DataClassJsonMixin):
""""""
""" """

last_tasks_updated_datetime: Optional[str]
"""タスクの最終更新日時"""


@dataclass
class ProjectConfiguration(DataClassJsonMixin):
""""""
""" """

number_of_inspections: Optional[int]
"""検査回数。 * 0回:教師付け -> 受入 * 1回:教師付け -> 検査 -> 受入 * n回(n >= 2):教師付け -> 検査1 -> ... -> 検査n -> 受入 """
Expand Down Expand Up @@ -81,7 +81,7 @@ class ProjectConfiguration(DataClassJsonMixin):

@dataclass
class Project(DataClassJsonMixin):
""""""
""" """

project_id: str
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
Expand Down
2 changes: 1 addition & 1 deletion annofabapi/dataclass/project_member.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

@dataclass
class ProjectMember(DataClassJsonMixin):
""""""
""" """

project_id: str
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
Expand Down
Loading