Skip to content

SDk Ref - Fixes create_dataset #908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Laverne-Encord wants to merge 4 commits into from
+5 −10
Closed

SDk Ref - Fixes create_dataset #908

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
46f39e2
SDk Ref - Fixes create_dataset
Laverne-Encord May 21, 2025
074b21c
Update encord/user_client.py
Laverne-Encord May 21, 2025
ca199c9
Minor update
Laverne-Encord May 21, 2025
5fc80d9
Minor fix
Laverne-Encord May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions encord/user_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,14 +264,10 @@ def create_dataset(
) -> CreateDatasetResponse:
"""
Args:
dataset_title:
Title of dataset.
dataset_type:
StorageLocation type where data will be stored.
dataset_description:
Optional description of the dataset.
create_backing_folder:
Specifies whether the Folder is mirrored to the Dataset. Mirrored Datasets have data synced between the Folder and Dataset. Mirrored Datasets are great for simple Projects, but we recommend non-Mirrored Datasets for more complex Projects or for data at scale. The default is False.
dataset_title: Title of dataset.
dataset_type: StorageLocation type where data will be stored.
dataset_description: Optional description of the dataset.
create_backing_folder: Specifies whether the Folder is mirrored to the Dataset. Mirrored Datasets have data synced between the Folder and Dataset. Mirrored Datasets are great for simple Projects, but we recommend non-Mirrored Datasets for more complex Projects or for data at scale. The default is True.
Returns:
CreateDatasetResponse
"""
Expand Down Expand Up @@ -1204,8 +1200,7 @@ def create_storage_folder(
client_metadata: Optional arbitrary metadata to be associated with the folder. Should be a dictionary
that is JSON-serializable.
parent_folder: The parent folder of the folder; or `None` if the folder is to be created at the root level.
cloud_synced_folder_params: Passing this will create cloud synced folder, leaving this a `None` will create
a normal folder for further data uploads.
cloud_synced_folder_params: Passing this parameter creates a cloud-synced folder. Specifying `None` creates a normal folder for data uploads.

Returns:
The created storage folder. See :class:`encord.storage.StorageFolder` for details.
Expand Down
Loading