Module `datatap.api.types.dataset`

Expand source code

from typing import List, Union

from datatap.template.image_annotation_template import \
    ImageAnnotationTemplateJson
from datatap.template.video_annotation_template import \
    VideoAnnotationTemplateJson
from typing_extensions import TypedDict


class JsonDatasetRepository(TypedDict):
    namespace: str
    name: str

class JsonDataset(TypedDict):
    """
    The API type of a dataset.
    """
    uid: str
    database: str
    repository: JsonDatasetRepository
    template: Union[ImageAnnotationTemplateJson, VideoAnnotationTemplateJson]
    splits: List[str]

Classes

class JsonDataset (*args, **kwargs)

The API type of a dataset.

Expand source code

class JsonDataset(TypedDict):
    """
    The API type of a dataset.
    """
    uid: str
    database: str
    repository: JsonDatasetRepository
    template: Union[ImageAnnotationTemplateJson, VideoAnnotationTemplateJson]
    splits: List[str]

Ancestors

builtins.dict

Class variables

var database : str
var repository : JsonDatasetRepository
var splits : List[str]
var template : Union[ImageAnnotationTemplateJson, VideoAnnotationTemplateJson]
var uid : str

class JsonDatasetRepository (*args, **kwargs)

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Expand source code

class JsonDatasetRepository(TypedDict):
    namespace: str
    name: str

Ancestors

builtins.dict

Class variables

var name : str
var namespace : str