Skip to main content
The dataset functions are deprecated. Please use the vessl.storage package to manage datasets with VESSL storage volumes.

​
read_dataset

Read a dataset in the default organization. If you want to override the default organization, then pass organization_name as **kwargs. Args
  • dataset_name (str) : Dataset name.
Example

​
read_dataset_version

Read the specific version of dataset in the default organization. If you want to override the default organization, then pass organization_name as **kwargs. Args
  • dataset_id (int) : Dataset id.
  • dataset_version_hash (str) : Dataset version hash.
Example

​
list_datasets

List datasets in the default organization. If you want to override the default organization, then pass organization_name as **kwargs. Example

​
create_dataset

Create a dataset in the default organization. If you want to override the default organization, then pass organization_name as **kwargs. Args
  • dataset_name (str) : Dataset name.
  • description (str) : dataset description. Defaults to None.
  • is_version_enabled (bool) : True if a dataset versioning is set, False otherwise. Defaults to False.
  • is_public (bool) : True if a dataset is source from a public bucket, False otherwise. Defaults to False.
  • external_path (str) : AWS S3 or Google Cloud Storage bucket URL. Defaults to None.
  • aws_role_arn (str) : AWS Role ARN to access S3. Defaults to None.
  • version_path (str) : Versioning bucket path. Defaults to None.
Example

​
list_dataset_volume_files

List dataset volume files in the default organization. If you want to override the default organization, then pass organization_name as **kwargs. Args
  • dataset_name (str) : Dataset name.
  • need_download_url (bool) : True if you need a download URL, False otherwise. Defaults to False.
  • path (str) : Directory path to list. Defaults to root(""),
  • recursive (bool) : True if list files recursively, False otherwise. Defaults to False.
Example

​
upload_dataset_volume_file

Upload file to the dataset. If you want to override the default organization, then pass organization_name as **kwargs. Args
  • dataset_name (str) : Dataset name.
  • source_path (str) : Local source path.
  • dest_path (str) : Destination path within the dataset.
Example

​
download_dataset_volume_file

Download file from the dataset. If you want to override the default organization, then pass organization_name as **kwargs. Args
  • dataset_name (str) : Dataset name.
  • source_path (str) : Source path within the dataset.
  • dest_path (str) : Local destination path.
Example

​
copy_dataset_volume_file

Copy files within the same dataset. Noted that this is not supported for externally sourced datasets like S3 or GCS. If you want to override the default organization, then pass organization_name as **kwargs. Args
  • dataset_name (str) : Dataset name.
  • source_path (str) : Source path within the dataset.
  • dest_path (str) : Local destination path.
Example

​
delete_dataset_volume_file

Delete the dataset volume file. Noted that this is not supported for externally sourced datasets like S3 or GCS. If you want to override the default organization, then pass organization_name as **kwargs. Args
  • dataset_name (str) : Dataset name.
  • path (str) : File path.
Example