Properties
nameName of this Dataset
Methods
add_tags
add_tags(
tags: Union[Tag, List[Tag]]
)
Description
Add some tags to an object.
It can be used on Data/MultiData/Asset/MultiAsset/DatasetVersion/Dataset/Model/ModelVersion.
You can give a Tag or a list of Tag.
Examples
tag_bicycle = client.create_tag("bicycle", Target.DATA)
tag_car = client.create_tag("car", Target.DATA)
tag_truck = client.create_tag("truck", Target.DATA)
data.add_tags(tag_bicycle)
data.add_tags([tag_car, tag_truck])
get_tags
get_tags()
Description
Retrieve the tags of your dataset.
Examples
tags = foo_dataset.get_tags()
assert tags[0].name == "my-dataset-1"
Returns
List of tags as Tag
delete
delete()
Description
Delete a dataset.
DANGER ZONE: Be very careful here!
It will remove this dataset from our database, its versions with their assets and annotations will be removed.
Examples
foo_dataset.delete()
update
update(
name: Optional[str] = None, private: Optional[bool] = None,
description: Optional[str] = None
)
Description
Update name, private or description of this Dataset.
Examples
dataset.update(description='My favourite dataset')
list_versions
list_versions(
limit: Optional[int] = None, offset: Optional[int] = None,
order_by: Optional[List[str]] = None
)
Description
List all versions of this dataset
Examples
dataset.list_versions()
get_version
get_version(
version: str
)
Description
Retrieve one version of a dataset
Examples
my_dataset_version = my_dataset.get_version("first")
get_version_by_id
get_version_by_id(
id: Union[UUID, str]
)
Description
Retrieve one version of a dataset
Examples
my_dataset_version = my_dataset.get_version("first")
create_version
create_version(
version: str, description: str = '', type: Union[InferenceType,
str] = InferenceType.NOT_CONFIGURED
)
Description
Create a version of this dataset.
A versioned dataset DatasetVersion takes Data from Datalake and transform it as annotable Asset.
Examples
foo_dataset = client.create_dataset('foo_dataset')
foo_dataset_version_1 = foo_dataset.create_version('first')
some_data = client.get_datalake().list_data(limit=10)
foo_dataset_version_1.add_data(some_data)
Returns
A DatasetVersion manipulable that can receive data
list_workers
list_workers()
Description
List all workers of this dataset
Examples
dataset.list_workers()
find_worker
find_worker(
username: str
)
Description
Find worker of this dataset from its username