nemo_microservices.types.dataset#

Module Contents#

Classes#

API#

class nemo_microservices.types.dataset.Dataset(/, **data: typing.Any)#

Bases: nemo_microservices._models.BaseModel

created_at: Optional[datetime.datetime]#

None

Timestamp for when the entity was created.

custom_fields: Optional[Dict[str, object]]#

None

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

description: Optional[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: Optional[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: Optional[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”.

id: Optional[str]#

None

The ID of the entity.

With the exception of namespaces, this is always a semantically-prefixed base58-encoded uuid4 [-base58(uuid4())].

limit: Optional[int]#

None

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

name: Optional[str]#

None

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: Optional[str]#

None

The namespace of the entity.

This can be missing for namespace entities or in deployments that don’t use namespaces.

project: Optional[str]#

None

The URN of the project associated with this entity.

split: Optional[str]#

None

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

updated_at: Optional[datetime.datetime]#

None

Timestamp for when the entity was last updated.