label-studio-sdk 0.0.34__py3-none-any.whl → 1.0.0__py3-none-any.whl

label_studio_sdk/types/project.py

@@ -0,0 +1,198 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from .project_sampling import ProjectSampling
+from .project_skip_queue import ProjectSkipQueue
+from .user_simple import UserSimple
+
+
+class Project(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Project name. Must be between 3 and 50 characters long.
+    """
+
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Project description
+    """
+
+    label_config: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Label config in XML format. See more about it in documentation
+    """
+
+    expert_instruction: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Labeling instructions in HTML format
+    """
+
+    show_instruction: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Show instructions to the annotator before they start
+    """
+
+    show_skip_button: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Show a skip button in interface and allow annotators to skip the task
+    """
+
+    enable_empty_annotation: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Allow annotators to submit empty annotations
+    """
+
+    show_annotation_history: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Show annotation history to annotator
+    """
+
+    organization: typing.Optional[int] = None
+    color: typing.Optional[str] = None
+    maximum_annotations: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Maximum number of annotations for one task. If the number of annotations per task is equal or greater to this value, the task is completed (is_labeled=True)
+    """
+
+    is_published: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Whether or not the project is published to annotators
+    """
+
+    model_version: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Machine learning model version
+    """
+
+    is_draft: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Whether or not the project is in the middle of being created
+    """
+
+    created_by: typing.Optional[UserSimple] = None
+    created_at: typing.Optional[dt.datetime] = None
+    min_annotations_to_start_training: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Minimum number of completed tasks after which model training is started
+    """
+
+    start_training_on_annotation_update: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Start model training after any annotations are submitted or updated
+    """
+
+    show_collab_predictions: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    If set, the annotator can view model predictions
+    """
+
+    num_tasks_with_annotations: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Tasks with annotations count
+    """
+
+    task_number: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Total task number in project
+    """
+
+    useful_annotation_number: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number
+    """
+
+    ground_truth_number: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Honeypot annotation number in project
+    """
+
+    skipped_annotations_number: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Skipped by collaborators annotation number in project
+    """
+
+    total_annotations_number: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Total annotations number in project including skipped_annotations_number and ground_truth_number.
+    """
+
+    total_predictions_number: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
+    """
+
+    sampling: typing.Optional[ProjectSampling] = None
+    show_ground_truth_first: typing.Optional[bool] = None
+    show_overlap_first: typing.Optional[bool] = None
+    overlap_cohort_percentage: typing.Optional[int] = None
+    task_data_login: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Task data credentials: login
+    """
+
+    task_data_password: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Task data credentials: password
+    """
+
+    control_weights: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
+    """
+
+    parsed_label_config: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    JSON-formatted labeling configuration
+    """
+
+    evaluate_predictions_automatically: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Retrieve and display predictions when loading a task
+    """
+
+    config_has_control_tags: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Flag to detect is project ready for labeling
+    """
+
+    skip_queue: typing.Optional[ProjectSkipQueue] = None
+    reveal_preannotations_interactively: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Reveal pre-annotations interactively
+    """
+
+    pinned_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Pinned date and time
+    """
+
+    finished_task_number: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Finished tasks
+    """
+
+    queue_total: typing.Optional[str] = None
+    queue_done: typing.Optional[str] = None
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/project_import.py

@@ -0,0 +1,63 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from .project_import_status import ProjectImportStatus
+
+
+class ProjectImport(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    preannotated_from_fields: typing.Optional[typing.Dict[str, typing.Any]] = None
+    commit_to_project: typing.Optional[bool] = None
+    return_task_ids: typing.Optional[bool] = None
+    status: typing.Optional[ProjectImportStatus] = None
+    url: typing.Optional[str] = None
+    traceback: typing.Optional[str] = None
+    error: typing.Optional[str] = None
+    created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Creation time
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Updated time
+    """
+
+    finished_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Complete or fail time
+    """
+
+    task_count: typing.Optional[int] = None
+    annotation_count: typing.Optional[int] = None
+    prediction_count: typing.Optional[int] = None
+    duration: typing.Optional[int] = None
+    file_upload_ids: typing.Optional[typing.Dict[str, typing.Any]] = None
+    could_be_tasks_list: typing.Optional[bool] = None
+    found_formats: typing.Optional[typing.Dict[str, typing.Any]] = None
+    data_columns: typing.Optional[typing.Dict[str, typing.Any]] = None
+    tasks: typing.Optional[typing.Dict[str, typing.Any]] = None
+    task_ids: typing.Optional[typing.Dict[str, typing.Any]] = None
+    project: typing.Optional[int] = None
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/project_import_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ProjectImportStatus = typing.Union[typing.Literal["created", "in_progress", "failed", "completed"], typing.Any]

label_studio_sdk/types/project_label_config.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+
+
+class ProjectLabelConfig(pydantic_v1.BaseModel):
+    label_config: str = pydantic_v1.Field()
+    """
+    Label config in XML format. See more about it in documentation
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/project_sampling.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ProjectSampling = typing.Union[
+    typing.Literal["Sequential sampling", "Uniform sampling", "Uncertainty sampling"], typing.Any
+]

label_studio_sdk/types/project_skip_queue.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ProjectSkipQueue = typing.Union[typing.Literal["REQUEUE_FOR_ME", "REQUEUE_FOR_OTHERS", "IGNORE_SKIPPED"], typing.Any]

label_studio_sdk/types/redis_export_storage.py

@@ -0,0 +1,117 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from .redis_export_storage_status import RedisExportStorageStatus
+
+
+class RedisExportStorage(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    type: typing.Optional[str] = None
+    synchronizable: typing.Optional[bool] = None
+    path: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage prefix (optional)
+    """
+
+    host: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Server Host IP (optional)
+    """
+
+    port: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Server Port (optional)
+    """
+
+    password: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Server Password (optional)
+    """
+
+    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage regex for filtering objects
+    """
+
+    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Interpret objects as BLOBs and generate URLs
+    """
+
+    last_sync: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Last sync finished time
+    """
+
+    last_sync_count: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Count of tasks synced last time
+    """
+
+    last_sync_job: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Last sync job ID
+    """
+
+    status: typing.Optional[RedisExportStorageStatus] = None
+    traceback: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Traceback report for the last failed sync
+    """
+
+    meta: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Meta and debug information about storage processes
+    """
+
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage title
+    """
+
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage description
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Creation time
+    """
+
+    can_delete_objects: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Deletion from storage enabled
+    """
+
+    db: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Server Database
+    """
+
+    project: int = pydantic_v1.Field()
+    """
+    A unique integer value identifying this project.
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/redis_export_storage_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+RedisExportStorageStatus = typing.Union[
+    typing.Literal["initialized", "queued", "in_progress", "failed", "completed"], typing.Any
+]

label_studio_sdk/types/redis_import_storage.py

@@ -0,0 +1,112 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from .redis_import_storage_status import RedisImportStorageStatus
+
+
+class RedisImportStorage(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    type: typing.Optional[str] = None
+    synchronizable: typing.Optional[bool] = None
+    path: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage prefix (optional)
+    """
+
+    host: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Server Host IP (optional)
+    """
+
+    port: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Server Port (optional)
+    """
+
+    password: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Server Password (optional)
+    """
+
+    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage regex for filtering objects
+    """
+
+    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Interpret objects as BLOBs and generate URLs
+    """
+
+    last_sync: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Last sync finished time
+    """
+
+    last_sync_count: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Count of tasks synced last time
+    """
+
+    last_sync_job: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Last sync job ID
+    """
+
+    status: typing.Optional[RedisImportStorageStatus] = None
+    traceback: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Traceback report for the last failed sync
+    """
+
+    meta: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Meta and debug information about storage processes
+    """
+
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage title
+    """
+
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage description
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Creation time
+    """
+
+    db: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Server Database
+    """
+
+    project: int = pydantic_v1.Field()
+    """
+    A unique integer value identifying this project.
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/redis_import_storage_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+RedisImportStorageStatus = typing.Union[
+    typing.Literal["initialized", "queued", "in_progress", "failed", "completed"], typing.Any
+]