diff --git a/api-reference/tilebox.datasets/Dataset.collection.mdx b/api-reference/tilebox.datasets/Dataset.collection.mdx index d60912b..519ce19 100644 --- a/api-reference/tilebox.datasets/Dataset.collection.mdx +++ b/api-reference/tilebox.datasets/Dataset.collection.mdx @@ -21,7 +21,7 @@ A collection object. ```python Python -collections = dataset.collection("My-collection") +collection = dataset.collection("My-collection") ``` diff --git a/api-reference/tilebox.datasets/Dataset.create_collection.mdx b/api-reference/tilebox.datasets/Dataset.create_collection.mdx new file mode 100644 index 0000000..f1b463e --- /dev/null +++ b/api-reference/tilebox.datasets/Dataset.create_collection.mdx @@ -0,0 +1,26 @@ +--- +title: Dataset.create_collection +icon: layer-group +--- + +```python +def Dataset.create_collection(name: str) -> Collection +``` + +Create a collection in the dataset. + +## Parameters + + + The name of the collection + + +## Returns + +The created collection object. + + +```python Python +collection = dataset.create_collection("My-collection") +``` + diff --git a/api-reference/tilebox.datasets/Dataset.get_or_create_collection.mdx b/api-reference/tilebox.datasets/Dataset.get_or_create_collection.mdx new file mode 100644 index 0000000..e1dac81 --- /dev/null +++ b/api-reference/tilebox.datasets/Dataset.get_or_create_collection.mdx @@ -0,0 +1,26 @@ +--- +title: Dataset.get_or_create_collection +icon: layer-group +--- + +```python +def Dataset.get_or_create_collection(name: str) -> Collection +``` + +Get a collection by its name. If the collection does not exist, it will be created. + +## Parameters + + + The name of the collection + + +## Returns + +A collection object. + + +```python Python +collection = dataset.get_or_create_collection("My-collection") +``` + diff --git a/datasets/collections.mdx b/datasets/collections.mdx index 1bb5f8b..bbe3438 100644 --- a/datasets/collections.mdx +++ b/datasets/collections.mdx @@ -10,11 +10,13 @@ Collections group data points within a dataset. They help represent logical grou This section provides a quick overview of the API for listing and accessing collections. Below are some usage examples for different scenarios. -| Method | API Reference | Description | -| --------------------- | ------------------------------------------------------------------------------- | --------------------------------------------- | -| `dataset.collections` | [Listing collections](/api-reference/tilebox.datasets/Dataset.collections) | List all available collections for a dataset. | -| `dataset.collection` | [Accessing a collection](/api-reference/tilebox.datasets/Dataset.collection) | Access an individual collection by its name. | -| `collection.info` | [Collection information](/api-reference/tilebox.datasets/Collection.info) | Request information about a collection. | +| Method | API Reference | Description | +| ---------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------ | +| `dataset.collections` | [Listing collections](/api-reference/tilebox.datasets/Dataset.collections) | List all available collections for a dataset. | +| `dataset.create_collection` | [Creating a collection](/api-reference/tilebox.datasets/Dataset.create_collection) | Create a collection in a dataset. | +| `dataset.get_or_create_collection` | [Accessing or creating a collection](/api-reference/tilebox.datasets/Dataset.get_or_create_collection) | Get a collection, create it if it doesn't exist. | +| `dataset.collection` | [Accessing a collection](/api-reference/tilebox.datasets/Dataset.collection) | Access an individual collection by its name. | +| `collection.info` | [Collection information](/api-reference/tilebox.datasets/Collection.info) | Request information about a collection. | Refer to the examples below for common use cases when working with collections. These examples assume that you have already [created a client](/datasets/introduction#creating-a-datasets-client) and [listed the available datasets](/api-reference/tilebox.datasets/Client.datasets). @@ -48,6 +50,24 @@ print(collections) [dataset.collections](/api-reference/tilebox.datasets/Dataset.collections) returns a dictionary mapping collection names to their corresponding collection objects. Each collection has a unique name within its dataset. +## Creating collections + +To create a collection in a dataset, use [dataset.create_collection()](/api-reference/tilebox.datasets/Dataset.create_collection). This method returns the created collection object. + + +```python Python +collection = dataset.create_collection("My-collection") +``` + + +Alternatively, you can use [dataset.get_or_create_collection()](/api-reference/tilebox.datasets/Dataset.get_or_create_collection) to get a collection by its name. If the collection does not exist, it will be created. + + +```python Python +collection = dataset.get_or_create_collection("My-collection") +``` + + ## Accessing individual collections Once you have listed the collections for a dataset using [dataset.collections()](/api-reference/tilebox.datasets/Dataset.collections), you can access a specific collection by retrieving it from the resulting dictionary with its name. Use [collection.info()](/api-reference/tilebox.datasets/Collection.info) to get details (name, availability, and count) about it. diff --git a/mint.json b/mint.json index df8762a..3f7f3f0 100644 --- a/mint.json +++ b/mint.json @@ -158,6 +158,8 @@ "api-reference/tilebox.datasets/Client.datasets", "api-reference/tilebox.datasets/Client.dataset", "api-reference/tilebox.datasets/Dataset.collections", + "api-reference/tilebox.datasets/Dataset.create_collection", + "api-reference/tilebox.datasets/Dataset.get_or_create_collection", "api-reference/tilebox.datasets/Dataset.collection", "api-reference/tilebox.datasets/Collection.info", "api-reference/tilebox.datasets/Collection.load",