Skip to content

Document environment dataset tags #2754

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
burtenshaw wants to merge 1 commit into
base: main
Choose a base branch
from
+28 −1
Open

Document environment dataset tags #2754

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion docs/hub/datasets-cards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,38 @@ tags:

### Associate a library to the dataset

The dataset page automatically shows libraries and tools that are able to natively load the dataset, but if you want to show another specific library, you can add a tag to the dataset card metadata: `argilla`, `dask`, `datasets`, `distilabel`, `fiftyone`, `mlcroissant`, `pandas`, `webdataset`. See the [list of supported libraries](https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/dataset-libraries.ts) for more information, or to propose to add a new library.
The dataset page automatically shows libraries and tools that are able to natively load the dataset, but if you want to show another specific library, you can add a tag to the dataset card metadata. Supported tags include `argilla`, `dask`, `datasets`, `distilabel`, `fiftyone`, `harbor`, `mlcroissant`, `nemo-gym`, `openenv`, `pandas`, `verifiers`, and `webdataset`. See the [list of supported libraries](https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/dataset-libraries.ts) for the complete list, or to propose a new library.

For example, to associate the `argilla` library to the dataset card, add the following to the dataset card metadata:

```yaml
tags:
- argilla
```

### Declare an RL environment dataset

An RL environment is an ordinary dataset repository whose files can be consumed by one or more environment frameworks. Add the `environment` tag to make the dataset discoverable with the **RL Environments** filter, then add a tag for each supported framework. The framework tags also add their generated commands to **Use this dataset**.

For example, a dataset containing Harbor task directories that can also be loaded by Verifiers uses this Dataset Card YAML:

```yaml
---
pretty_name: Terminal-Bench 2.0
tags:
- environment
- harbor
- verifiers
Comment on lines +88 to +96

@julien-c julien-c Sep 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't dataset-viewer be able to auto-detect those most of the times? (based on conventional filenames/file structures?) cc @lhoestq

@NathanHB NathanHB Sep 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

huggingface/dataset-viewer#3424 (comment)

@lhoestq lhoestq Sep 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup we can do that later

---
```

The supported environment framework tags are:

| Tag | Framework |
| --- | --- |
| `harbor` | [Harbor](https://github.com/harbor-framework/harbor) |
| `verifiers` | [Verifiers](https://github.com/PrimeIntellect-ai/verifiers) |
| `openenv` | [OpenEnv](https://github.com/huggingface/OpenEnv) |
| `nemo-gym` | [NeMo Gym](https://github.com/NVIDIA-NeMo/Gym) |

These tags describe compatibility and generate loading commands. They do not create a new repository type or cause the Hub to execute the environment.
Loading