Skip to content

dataset

DatasetExportV2

Bases: BaseModel

Class for Dataset export.

Attributes:

Name Type Description
name str
zarr_dir str
images list[SingleImage]
Source code in fractal_server/app/schemas/v2/dataset.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
class DatasetExportV2(BaseModel):
    """
    Class for `Dataset` export.

    Attributes:
        name:
        zarr_dir:
        images:
    """

    name: str
    zarr_dir: str
    images: list[SingleImage]

DatasetImportV2

Bases: BaseModel

Class for Dataset import.

We are dropping model_config = ConfigDict(extra="forbid") so that any kind of legacy filters can be included in the payload, and ignored in the API.

Attributes:

Name Type Description
name str
zarr_dir ZarrDirStr
images list[SingleImage]
Source code in fractal_server/app/schemas/v2/dataset.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
class DatasetImportV2(BaseModel):
    """
    Class for `Dataset` import.

    We are dropping `model_config = ConfigDict(extra="forbid")` so that any
    kind of legacy filters can be included in the payload, and ignored in the
    API.

    Attributes:
        name:
        zarr_dir:
        images:
    """

    name: str
    zarr_dir: ZarrDirStr
    images: list[SingleImage] = Field(default_factory=list)