Properties

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])

copy

copy()

Description

split

split(
   ratio: float
)

Description

delete

delete()

Description

Delete a bunch of data and remove them from datalake.

⚠️ DANGER ZONE: Be very careful here!

Remove a bunch of data from datalake, and all assets linked to each data.

Examples

whole_data = datalake.list_data(limit=3)
whole_data.delete()

download

download(
   target_path: Union[str, Path] = './', force_replace: bool = False,
   max_workers: Optional[int] = None, use_id: bool = False
)

Description

Download this multi data in given target path

Examples

bunch_of_data = client.get_datalake().list_data(limit=25)
bunch_of_data.download('./downloads/')

Arguments

target_path (str or Path, optional) : Target path where to download. Defaults to './'.
force_replace : (bool, optional): Replace an existing file if exists. Defaults to False.
max_workers (int, optional) : Number of max workers used to download. Defaults to os.cpu_count() + 4.
use_id (bool, optional) : If true, will download file with id and extension as file name. Defaults to False.

wait_for_upload_done

wait_for_upload_done(
   blocking_time_increment: float = 1.0, attempts: int = 20
)

Description