README.md

---
title: Simready Validator
emoji: 🏢
colorFrom: indigo
colorTo: gray
sdk: docker
pinned: false
---

# SimReady Validator

A hosted validator for [SimReady](https://github.com/NVIDIA/simready-foundation)
asset packages. Submit a HuggingFace dataset, pick a profile, and the Space
runs the SimReady foundation rules against it and reports back what passed,
what failed, and why — without copying your assets off HuggingFace.

## Using the validator

Click the **App** tab above to open the validator UI. In the form:

| Field | What to enter |
|---|---|
| **Dataset** | The HuggingFace dataset slug you want to validate (e.g. `your-org/your-asset-bundle`). The dataset must be readable by this Space's `HF_TOKEN`. |
| **Profile** | The SimReady profile that matches your asset type — props vs. robots, neutral vs. PhysX vs. Isaac. See the validation guide for the full list. |
| **Version** | Profile version. Leave at `1.0.0` unless your profile is pinned to a different release. |
| **Open PR on dataset with verdict** | When ticked, the verdict is written back to the dataset as a `validation/results.json` pull request. Leave off for ad-hoc smoke tests. |

Click **Validate** and the log streams in real time. When it finishes the
results.json appears in the **HTML report** download.

## Going deeper

- **[Partner walkthrough → VALIDATE.md](./blob/main/VALIDATE.md)** — the full nine-step guide from cloning the foundation repo to submitting your assets. Read this first if you're packaging assets for SimReady for the first time.
- **[NVIDIA/simready-foundation](https://github.com/NVIDIA/simready-foundation)** — public spec repo with profile authoring guides and sample assets.
- **[WRAPP on NGC](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/omniverse/collections/wrapp)** — packaging tool referenced in the walkthrough.

## About this Space

The validator reads the requested HuggingFace dataset in place via
`huggingface_hub.snapshot_download` — assets stay on HuggingFace, no
transfer onto NVIDIA infrastructure. Running on a `t4-medium` GPU
tier. PhysX / MDL rules that require an Isaac Sim runtime are not
covered here yet (Isaac Sim isn't in the Space image — that's a
separate workstream).