Dataset

Dataset


get_tags

Signature

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


get_resource_url_on_platform

Signature

get_resource_url_on_platform()

Description

Get platform url of this resource.

Examples

    print(foo_dataset.get_resource_url_on_platform())
    >>> "https://app.picsellia.com/dataset/62cffb84-b92c-450c-bc37-8c4dd4d0f590"

Returns

Url on Platform for this resource


delete

Signature

delete()

Description

Delete a dataset.

:warning: 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

Signature

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

Signature

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

Signature

get_version(
   version: str
)

Description

Retrieve one version of a dataset

Examples

    my_dataset_version = my_dataset.get_version("first")

get_version_by_id

Signature

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

Signature

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

Signature

list_workers()

Description

List all workers of this dataset

Examples

    dataset.list_workers()

find_worker

Signature

find_worker(
   username: str
)

Description

Find worker of this dataset from its username