Datasets
Get all datasets
Get a list of all your datasets:
datasets = client.get_datasets()
The get_datasets() method does not take any parameter.
Create a dataset
my_dataset = Dataset(
name= "Cats & dogs dataset",
description= "A dataset with labelled images of cats and dogs.",
multi_label= False,
notes= "Cats and dogs is often used as a demo dataset.",
default_splits= True,
content_type= ContentType.IMAGES
)
my_dataset = client.create_dataset(my_dataset)
| Parameter | Type | Description |
|---|
| dataset | Dataset | The entire dataset object |
Properties in more detail:
| Property | Type | Description |
|---|
| id | str | Unique id for the dataset |
| created_at | str | The creation date |
| updated_at | str | Last updated date |
| name | str | The dataset name |
| description | str | The dataset description |
| user_id | str | The unique id of the dataset creator |
| notes | str | More elaborate notes about the dataset |
| versions | List[DatasetVersion] | A list of all the version of the dataset (see below) |
| multi_label | bool | Flag indicating whether tiems can have multiple labels |
| default_splits | bool | Create default splits (“train”, “valid”, “test”) when creating the dataset. |
| has_logo | bool | Flag indicating whether the dataset has a logo or not |
| logo | str | Name and extension of the logo file |
| content_type | DatasetContentType | Type of items in the dataset. Possible values IMAGES, TEXT, TABULAR, NER. |
Get dataset
my_dataset = client.get_dataset(my_dataset.id)
| Parameter | Type | Description |
|---|
| dataset_id | str | The dataset id |
Update dataset
my_dataset.notes += "~25k labelled images of cats and dogs; 22500 for training, 2000 for validation."
client.update_dataset(my_dataset)
| Parameter | Type | Description |
|---|
| dataset | Dataset | The entire dataset object |
Delete dataset
client.delete_dataset(my_dataset.id)
| Parameter | Type | Description |
|---|
| dataset_id | str | The dataset id |
Upload dataset logo
my_dataset = client.upload_dataset_logo(my_dataset.id, folder="directory/to/logo", filename="logo_filename.jpg")
| Parameter | Type | Description |
|---|
| dataset_id | str | Unique id for the dataset |
| folder | str | Name of the folder that contains the logo file (without trailing ‘/’), default value “data” |
| filename | str | Name of the file to be uploaded, default value “logo.jpg”. Supported formats: jpg, jpeg, png. |
Download dataset logo
client.get_dataset_logo(my_dataset)
| Parameter | Type | Description |
|---|
| dataset | Dataset | The entire dataset object |