modelstudio-sdk 0.0.0.dev0__py3-none-any.whl

modelstudio/models/common.py

@@ -0,0 +1,18 @@
+"""Common/shared model types."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel
+
+
+class PagedResponse(BaseModel):
+    """Generic paged response wrapper matching the API's paginated response."""
+
+    content: list[dict[str, Any]] = []
+    total_elements: int = 0
+    total_pages: int = 0
+    page: int = 0
+    size: int = 0
+    facets: dict[str, Any] | None = None

modelstudio/models/datasets.py

@@ -0,0 +1,55 @@
+"""Dataset-related models."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel
+
+from modelstudio.models.splits import SplitModel
+
+
+class DatasetModel(BaseModel):
+    """Represents a dataset from GET /api/v1/datasets."""
+
+    id: UUID
+    parent_dataset_id: UUID | None = None
+    name: str
+    dataset_type: str
+    format: str
+    description: str | None = None
+    created_on: datetime | None = None
+    locked: bool = False
+    uploaded: bool = False
+    splits: list[SplitModel] = []
+    clone_status: str | None = None
+    clone_progress: int = 0
+    clone_error: str | None = None
+    clone_started_at: datetime | None = None
+    clone_finished_at: datetime | None = None
+    finalize_status: str | None = None
+    finalize_progress: int = 0
+    finalize_message: str | None = None
+    finalize_started_at: datetime | None = None
+    finalize_finished_at: datetime | None = None
+
+
+class CloneStatusModel(BaseModel):
+    """Clone operation status."""
+
+    clone_status: str | None = None
+    clone_progress: int = 0
+    clone_error: str | None = None
+    clone_started_at: datetime | None = None
+    clone_finished_at: datetime | None = None
+
+
+class FinalizeStatusModel(BaseModel):
+    """Finalize operation status."""
+
+    finalize_status: str | None = None
+    finalize_progress: int = 0
+    finalize_message: str | None = None
+    finalize_started_at: datetime | None = None
+    finalize_finished_at: datetime | None = None

modelstudio/models/deletion.py

@@ -0,0 +1,29 @@
+"""Deletion check models."""
+
+from __future__ import annotations
+
+from uuid import UUID
+
+from pydantic import BaseModel
+
+
+class ExperimentRefModel(BaseModel):
+    """An experiment referencing a dataset."""
+
+    experiment_id: UUID | None = None
+    experiment_name: str | None = None
+
+
+class DatasetRefModel(BaseModel):
+    """A child dataset reference."""
+
+    dataset_id: UUID | None = None
+    dataset_name: str | None = None
+
+
+class DeletionCheckModel(BaseModel):
+    """Response from GET /datasets/{id}/can-delete."""
+
+    can_delete: bool = False
+    referencing_experiments: list[ExperimentRefModel] = []
+    child_datasets: list[DatasetRefModel] = []

modelstudio/models/exports.py

@@ -0,0 +1,32 @@
+"""Export-related models."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel
+
+
+class ExportCocoModel(BaseModel):
+    """Response from POST /datasets/{id}/export/coco."""
+
+    coco_json: dict[str, Any] | None = None
+    image_count: int = 0
+    annotation_count: int = 0
+    category_count: int = 0
+    image_id_mapping: dict[str, int] | None = None
+    annotation_id_mapping: dict[str, int] | None = None
+    category_id_mapping: dict[str, int] | None = None
+    reindexed: bool = False
+
+
+class SegmentationExportModel(BaseModel):
+    """Response from POST /datasets/{id}/splits/{sid}/export/segmentation."""
+
+    split_id: str | None = None
+    images_archive_uri: str | None = None
+    masks_archive_uri: str | None = None
+    categories_uri: str | None = None
+    image_count: int = 0
+    mask_count: int = 0
+    images_without_masks: list[str] = []

modelstudio/models/few_shot.py

@@ -0,0 +1,41 @@
+"""Few-shot dataset creation models."""
+
+from __future__ import annotations
+
+from typing import Any
+from uuid import UUID
+
+from pydantic import BaseModel
+
+
+class FewShotRequest(BaseModel):
+    """Request for POST /datasets/{id}/few-shot."""
+
+    num_images: int
+    method: str = "RANDOM"
+    specific_image_ids: list[UUID] | None = None
+    specific_file_names: list[str] | None = None
+    new_dataset_name: str | None = None
+    new_dataset_description: str | None = None
+    seed: int | None = None
+
+
+class FewShotPreviewModel(BaseModel):
+    """Response from POST /datasets/{id}/few-shot/preview."""
+
+    selected_image_count: int = 0
+    total_annotations: int = 0
+    selected_images: list[dict[str, Any]] = []
+    class_coverage: dict[str, Any] = {}
+
+
+class FewShotResponseModel(BaseModel):
+    """Response from POST /datasets/{id}/few-shot."""
+
+    success: bool = False
+    message: str | None = None
+    new_dataset_id: str | None = None
+    new_dataset_name: str | None = None
+    images_included: int = 0
+    annotations_included: int = 0
+    categories_included: int = 0

modelstudio/models/filters.py

@@ -0,0 +1,81 @@
+"""Filter-related models."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel
+
+
+class CategoryFilter(BaseModel):
+    """Category filter options."""
+
+    keep_categories: list[str] | None = None
+    keep_category_ids: list[int] | None = None
+    exclude_mode: bool = False
+
+
+class BboxFilter(BaseModel):
+    """Bounding box filter options."""
+
+    min_width: float | None = None
+    max_width: float | None = None
+    min_height: float | None = None
+    max_height: float | None = None
+    min_area: float | None = None
+    max_area: float | None = None
+    min_aspect_ratio: float | None = None
+    max_aspect_ratio: float | None = None
+    min_width_meters: float | None = None
+    max_width_meters: float | None = None
+    min_height_meters: float | None = None
+    max_height_meters: float | None = None
+    min_area_m2: float | None = None
+    max_area_m2: float | None = None
+
+
+class AnnotationCountFilter(BaseModel):
+    """Annotation count filter options."""
+
+    min_annotations_per_image: int | None = None
+    max_annotations_per_image: int | None = None
+    count_only_categories: list[str] | None = None
+
+
+class DatasetFilterRequest(BaseModel):
+    """Request for POST /datasets/{id}/filter."""
+
+    category_filter: CategoryFilter | None = None
+    bbox_filter: BboxFilter | None = None
+    annotation_count_filter: AnnotationCountFilter | None = None
+    consolidate_labels: dict[str, str] | None = None
+    output_mode: str | None = None
+    new_dataset_name: str | None = None
+    new_dataset_description: str | None = None
+    dry_run: bool = False
+
+
+class FilterStatisticsModel(BaseModel):
+    """Filter operation statistics."""
+
+    original_images: int = 0
+    original_annotations: int = 0
+    original_categories: int = 0
+    filtered_images: int = 0
+    filtered_annotations: int = 0
+    filtered_categories: int = 0
+    removed_by_filter: dict[str, int] = {}
+    category_distribution: dict[str, Any] = {}
+
+
+class DatasetFilterResponse(BaseModel):
+    """Response from POST /datasets/{id}/filter."""
+
+    success: bool = False
+    message: str | None = None
+    mode: str | None = None
+    coco_json: dict[str, Any] | None = None
+    new_dataset_id: str | None = None
+    new_dataset_name: str | None = None
+    statistics: FilterStatisticsModel | None = None
+    dry_run: bool = False

modelstudio/models/history.py

@@ -0,0 +1,58 @@
+"""History and undo/redo models."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel
+
+
+class HistoryEntryModel(BaseModel):
+    """A single change in the dataset history."""
+
+    change_id: UUID | None = None
+    sequence_number: int | None = None
+    operation_type: str | None = None
+    short_description: str | None = None
+    detailed_description: str | None = None
+    changed_on: datetime | None = None
+    changed_by: str | None = None
+    is_undone: bool = False
+    is_reversible: bool = True
+
+
+class HistoryModel(BaseModel):
+    """Response from GET /datasets/{id}/history."""
+
+    dataset_id: UUID | None = None
+    current_position: int = 0
+    total_changes: int = 0
+    can_undo: bool = False
+    can_redo: bool = False
+    changes: list[HistoryEntryModel] = []
+
+
+class PreviewModel(BaseModel):
+    """Response from GET /datasets/{id}/history/preview-undo or preview-redo."""
+
+    can_perform: bool = False
+    description: str | None = None
+    operation_type: str | None = None
+    changed_on: datetime | None = None
+
+
+class UndoRedoResponse(BaseModel):
+    """Response from POST /datasets/{id}/history/undo or redo."""
+
+    success: bool = False
+    description: str | None = None
+    new_position: int = 0
+
+
+class RewindResponse(BaseModel):
+    """Response from POST /datasets/{id}/history/rewind."""
+
+    success: bool = False
+    operations_applied: int = 0
+    new_position: int = 0

modelstudio/models/images.py

@@ -0,0 +1,91 @@
+"""Image-related models."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel
+
+
+class ImageModel(BaseModel):
+    """Core image metadata."""
+
+    image_id: UUID
+    file_name: str | None = None
+    hash: str | None = None
+    width: int = 0
+    height: int = 0
+    file_type: str | None = None
+    source_info: str | None = None
+    path: str | None = None
+    uri: str | None = None
+    created_on: datetime | None = None
+    coco_id: int | None = None
+    storage_connection_id: UUID | None = None
+    full_tile_id: str | None = None
+    tile_spec: str | None = None
+    gsd_meters: float | None = None
+    is_synthetic: bool | None = None
+    mask_uri: str | None = None
+    mask_format: str | None = None
+    band_count: int | None = None
+    band_names: str | None = None
+    pixel_data_type: str | None = None
+    preview_uri: str | None = None
+
+
+class DatasetImageModel(BaseModel):
+    """Image as part of a dataset split."""
+
+    dataset_image_id: UUID | None = None
+    split_id: UUID | None = None
+    image: ImageModel | None = None
+    added_on: datetime | None = None
+    thumb_url: str | None = None
+
+
+class SyntheticStatsModel(BaseModel):
+    """Response from GET /datasets/{id}/images/synthetic/stats."""
+
+    total_images: int = 0
+    real_images: int = 0
+    synthetic_images: int = 0
+    synthetic_ratio: float = 0.0
+
+
+class RemoveEmptyImagesResponse(BaseModel):
+    """Response from DELETE /datasets/{id}/images/empty."""
+
+    success: bool = False
+    message: str | None = None
+    images_removed: int = 0
+    removed_images: list[dict[str, object]] = []
+
+
+class MarkSyntheticResponse(BaseModel):
+    """Response from PUT /datasets/{id}/images/synthetic."""
+
+    success: bool = False
+    message: str | None = None
+    images_updated: int = 0
+
+
+class PaginatedImageModel(BaseModel):
+    """An image in the paginated dataset-level image listing."""
+
+    dataset_image_id: UUID | None = None
+    image: ImageModel | None = None
+    added_on: datetime | None = None
+    thumb_url: str | None = None
+    mask_uri: str | None = None
+    mask_format: str | None = None
+    mask_version: int | None = None
+    annotation_count: int = 0
+    tags: list[str] = []
+    file_size: int | None = None
+    cloud_cover: float | None = None
+    off_nadir_angle: float | None = None
+    sensor_type: str | None = None
+    provider: str | None = None
+    constellation: str | None = None

modelstudio/models/imports.py

@@ -0,0 +1,141 @@
+"""Import-related models."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any
+from uuid import UUID
+
+from pydantic import BaseModel
+
+
+class ImportQueuedModel(BaseModel):
+    """Response from POST /datasets/{id}/splits/{sid}/import/{source} (202)."""
+
+    split_id: UUID | None = None
+    status: str | None = None
+    progress: int = 0
+    source: str | None = None
+    poll_url: str | None = None
+
+
+class ImportStatusModel(BaseModel):
+    """Response from GET /datasets/{id}/splits/{sid}/import/status."""
+
+    split_id: UUID | None = None
+    status: str | None = None
+    progress: int = 0
+    error: str | None = None
+    started_at: datetime | None = None
+    finished_at: datetime | None = None
+
+
+class ValidationIssueModel(BaseModel):
+    """A single validation issue from pre-import validation."""
+
+    check: str | None = None
+    severity: str | None = None
+    message: str | None = None
+    entity_type: str | None = None
+    entity_id: str | None = None
+    details: dict[str, Any] | None = None
+
+
+class ImportConflictModel(BaseModel):
+    """A conflict found during pre-import validation."""
+
+    type: str | None = None
+    severity: str | None = None
+    message: str | None = None
+    details: dict[str, Any] | None = None
+    options: list[str] = []
+
+
+class PreImportSummaryModel(BaseModel):
+    """Summary statistics from pre-import validation."""
+
+    total_images: int = 0
+    total_annotations: int = 0
+    total_categories: int = 0
+    empty_images: int = 0
+    small_annotations: int = 0
+    orphan_annotations: int = 0
+    duplicate_annotations: int = 0
+    unused_categories: int = 0
+    invalid_bbox_count: int = 0
+    zero_area_bbox_count: int = 0
+    fixes_to_apply: list[str] = []
+
+
+class PreImportValidationModel(BaseModel):
+    """Response from GET /datasets/{id}/splits/{sid}/import/validate/{vid}."""
+
+    validation_id: str | None = None
+    status: str | None = None
+    progress: int = 0
+    can_proceed: bool = False
+    error_count: int = 0
+    warning_count: int = 0
+    conflict_count: int = 0
+    issues: list[ValidationIssueModel] = []
+    conflicts: list[ImportConflictModel] = []
+    summary: PreImportSummaryModel | None = None
+    started_at: datetime | None = None
+    finished_at: datetime | None = None
+    error_message: str | None = None
+
+
+class ValidationStartedModel(BaseModel):
+    """Response from POST /datasets/{id}/splits/{sid}/import/s3/validate (202)."""
+
+    validation_id: str | None = None
+    status: str | None = None
+    progress: int = 0
+    poll_url: str | None = None
+
+
+# ── Dataset-level import job models ──────────────────────────────────────
+
+
+class ImportLogEntryModel(BaseModel):
+    """A single log entry from an import job."""
+
+    ts: datetime | None = None
+    level: str | None = None
+    message: str | None = None
+
+
+class ImportJobModel(BaseModel):
+    """A dataset-level import job."""
+
+    job_id: UUID | None = None
+    dataset_id: UUID | None = None
+    split_id: UUID | None = None
+    source: str | None = None
+    dataset_type: str | None = None
+    status: str | None = None
+    progress: int = 0
+    error_summary: str | None = None
+    import_log: list[ImportLogEntryModel] | None = None
+    images_imported: int | None = None
+    source_details: dict[str, Any] | None = None
+    canceled: bool = False
+    created_at: datetime | None = None
+    started_at: datetime | None = None
+    finished_at: datetime | None = None
+
+
+class ImportJobListModel(BaseModel):
+    """Response from GET /datasets/{id}/imports."""
+
+    jobs: list[ImportJobModel] = []
+
+
+class ImportJobQueuedModel(BaseModel):
+    """Response from POST /datasets/{id}/imports/{jobId}/retry (202)."""
+
+    job_id: UUID | None = None
+    split_id: UUID | None = None
+    status: str | None = None
+    source: str | None = None
+    poll_url: str | None = None

modelstudio/models/media.py

@@ -0,0 +1,37 @@
+"""Media job models."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel
+
+
+class MediaJobErrorModel(BaseModel):
+    """A single error from a media processing job."""
+
+    job_id: UUID | None = None
+    image_id: UUID | None = None
+    image_name: str | None = None
+    error: str | None = None
+    updated_at: datetime | None = None
+
+
+class MediaJobStatusModel(BaseModel):
+    """Aggregate status of media processing jobs for a dataset."""
+
+    total: int = 0
+    queued: int = 0
+    processing: int = 0
+    done: int = 0
+    error: int = 0
+    recent_errors: list[MediaJobErrorModel] = []
+
+
+class MediaJobActionModel(BaseModel):
+    """Response from a media job action (retry, cancel)."""
+
+    action: str | None = None
+    count: int = 0
+    message: str | None = None

modelstudio/models/merge.py

@@ -0,0 +1,51 @@
+"""Dataset merge models."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel
+
+
+class MergeDatasetRequest(BaseModel):
+    """Request for POST /datasets/merge."""
+
+    source_dataset_ids: list[str]
+    target_name: str
+    target_description: str | None = None
+    include_categories: list[str] | None = None
+    keep_images_with_no_annotations: bool = True
+    conflict_strategy: str | None = None
+    category_mapping: dict[str, str] | None = None
+
+
+class MergePreviewModel(BaseModel):
+    """Response from POST /datasets/merge/preview."""
+
+    total_images: int = 0
+    total_annotations: int = 0
+    total_categories: int = 0
+    merged_categories: list[str] = []
+    warnings: list[str] = []
+    source_contributions: dict[str, Any] = {}
+
+
+class MergeAnalysisModel(BaseModel):
+    """Response from POST /datasets/merge/analyze."""
+
+    all_categories: list[dict[str, Any]] = []
+    conflicts: list[dict[str, Any]] = []
+    suggested_mapping: dict[str, str] = {}
+    has_conflicts: bool = False
+
+
+class MergeResponseModel(BaseModel):
+    """Response from POST /datasets/merge."""
+
+    new_dataset_id: str | None = None
+    new_dataset_name: str | None = None
+    status: str | None = None
+    images_created: int = 0
+    annotations_created: int = 0
+    categories_created: int = 0
+    category_id_mapping: dict[str, int] = {}