nemo_microservices.types.dataset_update_params#

Module Contents#

Classes#

API#

class nemo_microservices.types.dataset_update_params.DatasetUpdateParams#

Bases: typing_extensions.TypedDict

custom_fields: Dict[str, object]#

None

A set of custom fields that the user can define and use for various purposes.

description: str#

None

The description of the entity.

files_url: str#

None

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: str#

None

Specifies the dataset format, referring to the schema of the dataset rather than the file format. Examples include SQuAD, BEIR, etc.

hf_endpoint: str#

None

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: int#

None

The maximum number of items to be used from the dataset.

namespace: typing_extensions.Required[str]#

None

ownership: nemo_microservices.types.shared_params.ownership.Ownership#

None

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: str#

None

The URN of the project associated with this entity.

split: str#

None

The split of the dataset. Examples include train, validation, test, etc.