superb-ai-onprem 0.6.2__py3-none-any.whl → 0.7.0__py3-none-any.whl

spb_onprem/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.6.2'
-__version_tuple__ = version_tuple = (0, 6, 2)
+__version__ = version = '0.7.0'
+__version_tuple__ = version_tuple = (0, 7, 0)
 
 __commit_id__ = commit_id = None

spb_onprem/activities/entities/activity.py

@@ -12,28 +12,35 @@ class SchemaType(str, Enum):
 
 
 class ActivitySchema(CustomBaseModel):
-    key: Optional[str] = None
-    schema_type: Optional[SchemaType] = None
-    required: Optional[bool] = None
-    default: Optional[Any] = None
+    """액티비티 스키마 정의"""
+    key: Optional[str] = Field(None, description="스키마 키")
+    schema_type: Optional[SchemaType] = Field(None, description="데이터 타입 (String, Number, Boolean 등)")
+    required: Optional[bool] = Field(None, description="필수 필드 여부")
+    default: Optional[Any] = Field(None, description="기본값")
 
 
 class Activity(CustomBaseModel):
-    id: Optional[str] = Field(None, alias="id")
-    dataset_id: Optional[str] = Field(None, alias="datasetId")
+    """
+    액티비티 엔터티
     
-    name: Optional[str] = Field(None, alias="name")
-    description: Optional[str] = Field(None, alias="description")
-    activity_type: Optional[str] = Field(None, alias="type")
+    데이터 처리 작업의 워크플로우를 정의합니다.
+    라벨링, 리뷰, 검증 등의 작업 프로세스를 관리합니다.
+    """
+    id: Optional[str] = Field(None, alias="id", description="액티비티 고유 식별자")
+    dataset_id: Optional[str] = Field(None, alias="datasetId", description="상위 데이터셋 ID")
     
-    progress_schema: Optional[List[ActivitySchema]] = Field(None, alias="progressSchema")
-    parameter_schema: Optional[List[ActivitySchema]] = Field(None, alias="parameterSchema")
+    name: Optional[str] = Field(None, alias="name", description="액티비티 이름")
+    description: Optional[str] = Field(None, alias="description", description="액티비티 설명")
+    activity_type: Optional[str] = Field(None, alias="type", description="액티비티 타입 (labeling, review 등)")
     
-    settings: Optional[dict] = Field(None, alias="settings")
+    progress_schema: Optional[List[ActivitySchema]] = Field(None, alias="progressSchema", description="진행상태 스키마 정의")
+    parameter_schema: Optional[List[ActivitySchema]] = Field(None, alias="parameterSchema", description="파라미터 스키마 정의")
     
-    meta: Optional[dict] = Field(None, alias="meta")
+    settings: Optional[dict] = Field(None, alias="settings", description="액티비티 설정 정보")
     
-    created_at: Optional[str] = Field(None, alias="createdAt")
-    created_by: Optional[str] = Field(None, alias="createdBy")
-    updated_at: Optional[str] = Field(None, alias="updatedAt")
-    updated_by: Optional[str] = Field(None, alias="updatedBy")
+    meta: Optional[dict] = Field(None, alias="meta", description="액티비티 메타데이터")
+    
+    created_at: Optional[str] = Field(None, alias="createdAt", description="생성일시 (ISO 8601)")
+    created_by: Optional[str] = Field(None, alias="createdBy", description="생성자")
+    updated_at: Optional[str] = Field(None, alias="updatedAt", description="수정일시 (ISO 8601)")
+    updated_by: Optional[str] = Field(None, alias="updatedBy", description="수정자")

spb_onprem/activities/entities/activity_history.py

@@ -13,19 +13,22 @@ class ActivityStatus(str, Enum):
 
 class ActivityHistory(CustomBaseModel):
     """
-    The activity history.
+    액티비티 실행 히스토리 엔터티
+    
+    액티비티의 개별 실행 기록을 관리합니다.
+    작업 진행 상태, 파라미터, 결과를 추적하는 데 사용됩니다.
     """
-    id: Optional[str] = Field(None, alias="id")
-    dataset_id: Optional[str] = Field(None, alias="datasetId")
-    activity_id: Optional[str] = Field(None, alias="jobId")
-    status: Optional[ActivityStatus] = Field(None, alias="status")
+    id: Optional[str] = Field(None, alias="id", description="액티비티 히스토리 고유 식별자")
+    dataset_id: Optional[str] = Field(None, alias="datasetId", description="상위 데이터셋 ID")
+    activity_id: Optional[str] = Field(None, alias="jobId", description="실행된 액티비티 ID")
+    status: Optional[ActivityStatus] = Field(None, alias="status", description="실행 상태 (PENDING, RUNNING, SUCCESS, FAILED, CANCELLED)")
     
-    parameters: Optional[dict] = Field(None, alias="parameters")
-    progress: Optional[dict] = Field(None, alias="progress")
+    parameters: Optional[dict] = Field(None, alias="parameters", description="실행 파라미터")
+    progress: Optional[dict] = Field(None, alias="progress", description="진행 상황 정보")
     
-    meta: Optional[dict] = Field(None, alias="meta")
+    meta: Optional[dict] = Field(None, alias="meta", description="실행 메타데이터")
     
-    created_at: Optional[str] = Field(None, alias="createdAt")
-    created_by: Optional[str] = Field(None, alias="createdBy")
-    updated_at: Optional[str] = Field(None, alias="updatedAt")
-    updated_by: Optional[str] = Field(None, alias="updatedBy")
+    created_at: Optional[str] = Field(None, alias="createdAt", description="생성일시 (ISO 8601)")
+    created_by: Optional[str] = Field(None, alias="createdBy", description="생성자")
+    updated_at: Optional[str] = Field(None, alias="updatedAt", description="수정일시 (ISO 8601)")
+    updated_by: Optional[str] = Field(None, alias="updatedBy", description="수정자")

spb_onprem/data/entities/annotation.py

@@ -1,27 +1,30 @@
 from typing import Optional, List
 
-from spb_onprem.base_model import CustomBaseModel
+from spb_onprem.base_model import CustomBaseModel, Field
 from spb_onprem.contents.entities import BaseContent
 
 
 class AnnotationVersion(CustomBaseModel):
     """
-    The version of the annotation.
-    Annotation version is the version of the data annotation.
-    This has the content of the data annotation.
+    어노테이션 버전 엔터티
+    
+    어노테이션의 특정 버전을 나타내며, 실제 어노테이션 파일 내용과 
+    버전별 메타데이터를 포함합니다.
     """
-    id: Optional[str] = None
-    channels: Optional[List[str]] = None
-    version: Optional[str] = None
-    content: Optional[BaseContent] = None
-    meta: Optional[dict] = None
+    id: Optional[str] = Field(None, description="버전 고유 식별자")
+    channels: Optional[List[str]] = Field(None, description="데이터 채널 목록 (rgb, depth 등)")
+    version: Optional[str] = Field(None, description="버전 문자열 (v1.0, v2.1 등)")
+    content: Optional[BaseContent] = Field(None, description="어노테이션 파일 컨텐츠")
+    meta: Optional[dict] = Field(None, description="버전별 메타데이터")
 
 
 class Annotation(CustomBaseModel):
     """
-    The annotation of the data.
-    Annotation has the versions of the data annotation.
+    어노테이션 엔터티
+    
+    데이터의 어노테이션 정보를 관리하며, 여러 버전의 어노테이션을 
+    포함할 수 있습니다.
     """
-    versions: Optional[List[AnnotationVersion]] = None
-    meta: Optional[dict] = None
+    versions: Optional[List[AnnotationVersion]] = Field(None, description="어노테이션 버전 목록")
+    meta: Optional[dict] = Field(None, description="메인 어노테이션 메타데이터")
 

spb_onprem/data/entities/data.py

@@ -11,21 +11,35 @@ from spb_onprem.contents.entities import BaseContent
 
 class Data(CustomBaseModel):
     """
-    THE DATA.
+    메인 데이터 엔터티 - 데이터셋 내의 개별 데이터 항목
+    
+    데이터는 이미지, 비디오, 텍스트 등 다양한 형태의 컨텐츠를 나타내며,
+    어노테이션, 메타데이터, 슬라이스 정보 등을 포함합니다.
     """
-    id: Optional[str] = None
-    dataset_id: Optional[str] = Field(None, alias="datasetId")
-    slice_ids: Optional[List[str]] = Field(None, alias="sliceIds")
-    key: Optional[str] = None
-    type: Optional[DataType] = None
-    scene: Optional[List[Scene]] = None
-    frames: Optional[List[Frame]] = None
-    thumbnail: Optional[BaseContent] = None
-    annotation: Optional[Annotation] = None
-    predictions: Optional[List[Prediction]] = None
-    meta: Optional[List[DataMeta]] = None
-    created_at: Optional[str] = Field(None, alias="createdAt")
-    created_by: Optional[str] = Field(None, alias="createdBy")
-    updated_at: Optional[str] = Field(None, alias="updatedAt")
-    updated_by: Optional[str] = Field(None, alias="updatedBy")
-    slices: Optional[List[DataSlice]] = None
+    # 식별자
+    id: Optional[str] = Field(None, description="데이터 고유 식별자")
+    dataset_id: Optional[str] = Field(None, alias="datasetId", description="상위 데이터셋 ID")
+    slice_ids: Optional[List[str]] = Field(None, alias="sliceIds", description="소속된 슬라이스 ID 목록")
+    key: Optional[str] = Field(None, description="사용자 정의 고유 키")
+    
+    # 데이터 타입 및 내용
+    type: Optional[DataType] = Field(None, description="데이터 타입 (IMAGE, VIDEO 등)")
+    scene: Optional[List[Scene]] = Field(None, description="컨텐츠/파일 정보")
+    frames: Optional[List[Frame]] = Field(None, description="프레임 정보 (비디오 데이터용)")
+    thumbnail: Optional[BaseContent] = Field(None, description="썸네일 이미지")
+    
+    # 어노테이션 및 예측
+    annotation: Optional[Annotation] = Field(None, description="어노테이션 데이터")
+    predictions: Optional[List[Prediction]] = Field(None, description="ML 모델 예측 결과")
+    
+    # 메타데이터
+    meta: Optional[List[DataMeta]] = Field(None, description="커스텀 메타데이터 목록")
+    
+    # 시간 정보
+    created_at: Optional[str] = Field(None, alias="createdAt", description="생성일시 (ISO 8601)")
+    created_by: Optional[str] = Field(None, alias="createdBy", description="생성자")
+    updated_at: Optional[str] = Field(None, alias="updatedAt", description="수정일시 (ISO 8601)")
+    updated_by: Optional[str] = Field(None, alias="updatedBy", description="수정자")
+    
+    # 슬라이스 정보
+    slices: Optional[List[DataSlice]] = Field(None, description="슬라이스 멤버십 정보")

spb_onprem/data/entities/data_meta.py

@@ -24,7 +24,7 @@ class DataMeta(CustomBaseModel):
                     DataMetaTypes.NUMBER if isinstance(val, (int, float)) else
                     DataMetaTypes.DATETIME if isinstance(val, datetime) else
                     DataMetaTypes.STRING if isinstance(val, str) else
-                    DataMetaTypes.ANNOTATION  # list or dict
+                    DataMetaTypes.STRING
                 ),
             )
             for key, val in meta.items()

spb_onprem/data/entities/data_slice.py

@@ -5,13 +5,16 @@ from .annotation import Annotation
 
 class DataSlice(CustomBaseModel):
     """
-    데이터 슬라이스 정보를 담는 클래스
+    데이터 슬라이스 멤버십 엔터티
+    
+    특정 슬라이스 내에서의 데이터 상태와 워크플로 정보를 나타냅니다.
+    라벨링, 리뷰 등의 작업 진행 상황을 추적합니다.
     """
-    id: Optional[str] = None
-    status: Optional[DataStatus] = DataStatus.PENDING
-    labeler: Optional[str] = None
-    reviewer: Optional[str] = None
-    tags: Optional[List[str]] = None
-    status_changed_at: Optional[str] = Field(None, alias="statusChangedAt")
-    annotation: Optional[Annotation] = None
-    meta: Optional[Any] = None 
+    id: Optional[str] = Field(None, description="슬라이스 고유 식별자")
+    status: Optional[DataStatus] = Field(DataStatus.PENDING, description="워크플로 상태 (UNLABELED, LABELED, REVIEWED 등)")
+    labeler: Optional[str] = Field(None, description="할당된 라벨러")
+    reviewer: Optional[str] = Field(None, description="할당된 리뷰어")
+    tags: Optional[List[str]] = Field(None, description="슬라이스 태그 목록")
+    status_changed_at: Optional[str] = Field(None, alias="statusChangedAt", description="상태 변경일시")
+    annotation: Optional[Annotation] = Field(None, description="슬라이스별 어노테이션")
+    meta: Optional[dict] = Field(None, description="슬라이스별 메타데이터") 

spb_onprem/data/entities/frame.py

@@ -3,17 +3,20 @@ from spb_onprem.base_model import CustomBaseModel, Field
 
 
 class GeoLocation(CustomBaseModel):
-    lat: float
-    lon: float
+    """지리적 위치 정보"""
+    lat: float = Field(description="위도")
+    lon: float = Field(description="경도")
 
 
 class Frame(CustomBaseModel):
     """
-    The frame of the data.
-    Frame is the representation of a single frame in a sequence of data, such as a video or time series.
+    비디오/시계열 데이터의 프레임 엔터티
+    
+    비디오나 시계열 데이터의 개별 프레임을 나타냅니다.
+    타임스탬프, 지리적 위치, 메타데이터를 포함합니다.
     """
-    id: Optional[str] = None
-    index: Optional[int] = None
-    captured_at: Optional[str] = Field(None, alias="capturedAt")
-    geo_location: Optional[GeoLocation] = Field(None, alias="geoLocation")
-    meta: Optional[dict] = None
+    id: Optional[str] = Field(None, description="프레임 고유 식별자")
+    index: Optional[int] = Field(None, description="프레임 인덱스 (시퀀스 내 순서)")
+    captured_at: Optional[str] = Field(None, alias="capturedAt", description="촬영/캡처 시간 (ISO 8601)")
+    geo_location: Optional[GeoLocation] = Field(None, alias="geoLocation", description="촬영 위치 정보")
+    meta: Optional[dict] = Field(None, description="프레임별 메타데이터")

spb_onprem/data/entities/prediction.py

@@ -5,9 +5,11 @@ from spb_onprem.contents.entities import BaseContent
 
 class Prediction(CustomBaseModel):
     """
-    The prediction of the data.
-    Prediction has the predictions of the data.
+    ML 모델 예측 결과 엔터티
+    
+    기계학습 모델이 생성한 예측 결과를 나타냅니다.
+    어노테이션과 비교하여 모델 성능을 평가하는 데 사용됩니다.
     """
-    set_id: Optional[str] = Field(None, alias="setId")
-    content: Optional[BaseContent] = None
-    meta: Optional[dict] = None
+    set_id: Optional[str] = Field(None, alias="setId", description="예측 세트 식별자 - 같은 모델/버전의 예측들을 그룹화")
+    content: Optional[BaseContent] = Field(None, description="예측 결과 파일 (JSON, XML 등)")
+    meta: Optional[dict] = Field(None, description="예측 관련 메타데이터 (모델 버전, 신뢰도 점수 등)")

spb_onprem/data/entities/scene.py

@@ -1,14 +1,16 @@
 from typing import Optional
-from spb_onprem.base_model import CustomBaseModel
+from spb_onprem.base_model import CustomBaseModel, Field
 from spb_onprem.data.enums import SceneType
 from spb_onprem.contents.entities import BaseContent
 
 class Scene(CustomBaseModel):
     """
-    The scene of the data.
-    Scene is the representation of the file of the data.
+    데이터의 씬(Scene) 엔터티
+    
+    데이터의 실제 파일 표현을 나타냅니다.
+    이미지, 비디오, 텍스트 파일 등의 컨텐츠 정보를 포함합니다.
     """
-    id: Optional[str] = None
-    type: Optional[SceneType] = None
-    content: Optional[BaseContent] = None
-    meta: Optional[dict] = None
+    id: Optional[str] = Field(None, description="씬 고유 식별자")
+    type: Optional[SceneType] = Field(None, description="씬 타입 (IMAGE, VIDEO, TEXT 등)")
+    content: Optional[BaseContent] = Field(None, description="실제 파일 컨텐츠 정보")
+    meta: Optional[dict] = Field(None, description="씬별 메타데이터")

spb_onprem/data/enums/data_meta_type.py

@@ -9,7 +9,6 @@ class DataMetaTypes(str, Enum):
     NUMBER = "Number"
     BOOLEAN = "Boolean"
     DATETIME = "DateTime"
-    ANNOTATION = "Annotation"
 
 
 DataMetaValue = Union[str, int, float, bool, datetime, dict, list]