nemo_microservices.types.dataset_list_params#

Module Contents#

Classes#

API#

class nemo_microservices.types.dataset_list_params.DatasetListParams#

Bases: typing_extensions.TypedDict

filter: nemo_microservices.types.dataset_filter_param.DatasetFilterParam#

None

Filter configs on various criteria.

page: int#

None

Page number.

page_size: int#

None

Page size.

search: nemo_microservices.types.dataset_search_param.DatasetSearchParam#

None

Search datasets using substring matching.

You can combine multiple search fields and filters.

For example:

  • ?search[name]=imagenet: searches all datasets with ‘imagenet’ in the name.

  • ?search[format]=csv: searches all datasets with ‘csv’ in the format.

  • ?search[split]=train: searches all datasets with ‘train’ in the split.

  • ?search[namespace]=research: searches all datasets with ‘research’ in the namespace.

  • ?search[name]=imagenet&search[split]=validation: searches all datasets with ‘imagenet’ in the name AND ‘validation’ in the split.

  • ?search[name]=imagenet&search[name]=coco: searches all datasets with ‘imagenet’ OR ‘coco’ in the name.

  • ?search[updated_at][start]=2024-01-01T00:00:00 finds all datasets updated on or after the start date

  • ?search[created_at][start]=2022-01-01&search[updated_at][end]=2024-01-01 finds all datasets created from start date up to and including end date

sort: nemo_microservices.types.dataset_sort_field.DatasetSortField#

None

The field to sort by.

To sort in decreasing order, use - in front of the field name.