Entity Datasets Resource#

class nemo_microservices.resources.DatasetsResource(client: NeMoMicroservices)#

Bases: SyncAPIResource

property with_raw_response: DatasetsResourceWithRawResponse#

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#accessing-raw-response-data-e-g-headers

property with_streaming_response: DatasetsResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#with_streaming_response

Create a new dataset.

Parameters:

files_url – The location where the artifact files are stored. This can be a URL pointing to NDS, Hugging Face, S3, or any other accessible resource location.
custom_fields – A set of custom fields that the user can define and use for various purposes.
description – The description of the entity.
format – Specifies the dataset format, referring to the schema of the dataset rather than the file format. Examples include SQuAD, BEIR, etc.
hf_endpoint – For HuggingFace URLs, the endpoint that should be used. By default, this is set to the Data Store URL. For HuggingFace Hub, this should be set to “https://huggingface.co”.
limit – The maximum number of items to be used from the dataset.
name – The name of the entity. Must be unique inside the namespace. If not specified, it will be the same as the automatically generated id.
namespace – The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.
ownership –
Information about ownership of an entity.

If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.
project – The URN of the project associated with this entity.
split – The split of the dataset. Examples include train, validation, test, etc.
extra_headers – Send extra headers
extra_query – Add additional query parameters to the request
extra_body – Add additional JSON properties to the request
timeout – Override the client-level default timeout for this request, in seconds

Get Dataset

Parameters:

extra_headers – Send extra headers
extra_query – Add additional query parameters to the request
extra_body – Add additional JSON properties to the request
timeout – Override the client-level default timeout for this request, in seconds

Update dataset metadata.

If the request body has an empty field, keep the old value.

Parameters:

custom_fields – A set of custom fields that the user can define and use for various purposes.
description – The description of the entity.
files_url – The location where the artifact files are stored. This can be a URL pointing to NDS, Hugging Face, S3, or any other accessible resource location.
format – Specifies the dataset format, referring to the schema of the dataset rather than the file format. Examples include SQuAD, BEIR, etc.
hf_endpoint – For HuggingFace URLs, the endpoint that should be used. By default, this is set to the Data Store URL. For HuggingFace Hub, this should be set to “https://huggingface.co”.
limit – The maximum number of items to be used from the dataset.
ownership –
Information about ownership of an entity.

If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.
project – The URN of the project associated with this entity.
split – The split of the dataset. Examples include train, validation, test, etc.
extra_headers – Send extra headers
extra_query – Add additional query parameters to the request
extra_body – Add additional JSON properties to the request
timeout – Override the client-level default timeout for this request, in seconds

List all datasets.

Parameters:

filter – Filter configs on various criteria.
page – Page number.
page_size – Page size.
sort – The field to sort by. To sort in decreasing order, use - in front of the field name.
extra_headers – Send extra headers
extra_query – Add additional query parameters to the request
extra_body – Add additional JSON properties to the request
timeout – Override the client-level default timeout for this request, in seconds

Delete Dataset

Parameters:

extra_headers – Send extra headers
extra_query – Add additional query parameters to the request
extra_body – Add additional JSON properties to the request
timeout – Override the client-level default timeout for this request, in seconds

create_from_dict(data: dict[str, object]) → object#

class nemo_microservices.resources.AsyncDatasetsResource(client: AsyncNeMoMicroservices)#

Bases: AsyncAPIResource

property with_raw_response: AsyncDatasetsResourceWithRawResponse#

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#accessing-raw-response-data-e-g-headers

property with_streaming_response: AsyncDatasetsResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#with_streaming_response

Create a new dataset.

Parameters:

files_url – The location where the artifact files are stored. This can be a URL pointing to NDS, Hugging Face, S3, or any other accessible resource location.
custom_fields – A set of custom fields that the user can define and use for various purposes.
description – The description of the entity.
format – Specifies the dataset format, referring to the schema of the dataset rather than the file format. Examples include SQuAD, BEIR, etc.
hf_endpoint – For HuggingFace URLs, the endpoint that should be used. By default, this is set to the Data Store URL. For HuggingFace Hub, this should be set to “https://huggingface.co”.
limit – The maximum number of items to be used from the dataset.
name – The name of the entity. Must be unique inside the namespace. If not specified, it will be the same as the automatically generated id.
namespace – The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.
ownership –
Information about ownership of an entity.

If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.
project – The URN of the project associated with this entity.
split – The split of the dataset. Examples include train, validation, test, etc.
extra_headers – Send extra headers
extra_query – Add additional query parameters to the request
extra_body – Add additional JSON properties to the request
timeout – Override the client-level default timeout for this request, in seconds

Get Dataset

Parameters:

extra_headers – Send extra headers
extra_query – Add additional query parameters to the request
extra_body – Add additional JSON properties to the request
timeout – Override the client-level default timeout for this request, in seconds

Update dataset metadata.

If the request body has an empty field, keep the old value.

Parameters:

custom_fields – A set of custom fields that the user can define and use for various purposes.
description – The description of the entity.
files_url – The location where the artifact files are stored. This can be a URL pointing to NDS, Hugging Face, S3, or any other accessible resource location.
format – Specifies the dataset format, referring to the schema of the dataset rather than the file format. Examples include SQuAD, BEIR, etc.
hf_endpoint – For HuggingFace URLs, the endpoint that should be used. By default, this is set to the Data Store URL. For HuggingFace Hub, this should be set to “https://huggingface.co”.
limit – The maximum number of items to be used from the dataset.
ownership –
Information about ownership of an entity.

If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.
project – The URN of the project associated with this entity.
split – The split of the dataset. Examples include train, validation, test, etc.
extra_headers – Send extra headers
extra_query – Add additional query parameters to the request
extra_body – Add additional JSON properties to the request
timeout – Override the client-level default timeout for this request, in seconds

List all datasets.

Parameters:

filter – Filter configs on various criteria.
page – Page number.
page_size – Page size.
sort – The field to sort by. To sort in decreasing order, use - in front of the field name.
extra_headers – Send extra headers
extra_query – Add additional query parameters to the request
extra_body – Add additional JSON properties to the request
timeout – Override the client-level default timeout for this request, in seconds

Delete Dataset

Parameters:

extra_headers – Send extra headers
extra_query – Add additional query parameters to the request
extra_body – Add additional JSON properties to the request
timeout – Override the client-level default timeout for this request, in seconds

create_from_dict( data: dict[str, object], ) → object#