| --- |
| license: other |
| license_name: mixed-cc0-mit |
| license_link: https://huggingface.co/datasets/gerchowl/mat-vis/blob/main/LICENSES/README.md |
| pretty_name: mat-vis — PBR material catalog |
| task_categories: |
| - image-to-image |
| - image-classification |
| tags: |
| - pbr |
| - materials |
| - textures |
| - graphics |
| - 3d |
| - rendering |
| - mtlx |
| - materialx |
| size_categories: |
| - 1K<n<10K |
| --- |
| |
| # mat-vis — PBR material catalog |
|
|
| Open, browseable catalog of physically-based rendering (PBR) materials |
| aggregated from four upstream sources. Served as atomic, immutable |
| tagged revisions with tar containers + JSON sidecar offset maps for |
| channel-level HTTP range reads. |
|
|
| - **Canonical client:** [`mat-vis-client`](https://pypi.org/project/mat-vis-client/) (PyPI) — pins a single dataset revision per release. |
| - **Source repo / baker:** [github.com/MorePET/mat-vis](https://github.com/MorePET/mat-vis) |
| - **Schema source-of-truth:** [`docs/specs/index-schema.json`](https://github.com/MorePET/mat-vis/blob/main/docs/specs/index-schema.json) |
| - **Architecture:** [ADR-0007 — Substrate move to HF Datasets + tar container](https://github.com/MorePET/mat-vis/blob/main/docs/decisions/0007-substrate-move-to-hf-datasets-and-tar-container.md) |
|
|
| ## Sources and licenses |
|
|
| | Source | Upstream | License | Attribution | |
| |---|---|---|---| |
| | ambientcg | <https://ambientcg.com> | CC0-1.0 | Public-domain dedication | |
| | polyhaven | <https://polyhaven.com> | CC0-1.0 | Public-domain dedication | |
| | physicallybased | <https://physicallybased.info> | CC0-1.0 | Public-domain dedication | |
| | gpuopen | <https://matlib.gpuopen.com> | MIT | © 2022 Advanced Micro Devices, Inc. — see [`LICENSES/AMD-NOTICE.txt`](LICENSES/AMD-NOTICE.txt) | |
|
|
| Full license texts live in [`LICENSES/`](LICENSES/README.md). When |
| redistributing gpuopen-derived material data, preserve the AMD |
| attribution. |
|
|
| ## Layout per tagged revision |
|
|
| ``` |
| v2026.05.0/ |
| release-manifest.json # {tier: {source: {tar_url, rowmap_url, materials_count}}} |
| ambientcg.json # per-source catalog: id, category, scalars, source_url |
| polyhaven.json |
| gpuopen.json |
| physicallybased.json |
| ambientcg-1k.tar # one tar per (source, tier) |
| ambientcg-1k-rowmap.json # {material_id: {channel: {offset, length}}} |
| polyhaven-1k.tar + polyhaven-1k-rowmap.json |
| … |
| ktx2/<source>-<tier>.tar + ktx2/<source>-<tier>-rowmap.json |
| <source>-mtlx.json # MaterialX graph index (gpuopen, polyhaven, ambientcg) |
| ``` |
|
|
| Every revision is an atomic Hugging Face commit — manifest + tars + |
| rowmaps + index land together or not at all. |
|
|
| ## Accessing data |
|
|
| ### Python client (recommended) |
|
|
| ```bash |
| uv add mat-vis-client |
| ``` |
|
|
| ```python |
| from mat_vis_client import Client |
| |
| client = Client() # pins a revision compatible with this client version |
| png_bytes = client.fetch("ambientcg", "Bricks080", channel="diffuse", tier="1k") |
| ``` |
|
|
| ### Direct HTTP range reads |
|
|
| ``` |
| base = https://huggingface.co/datasets/gerchowl/mat-vis/resolve/<revision>/ |
| manifest = base + "release-manifest.json" |
| rowmap = base + "ambientcg-1k-rowmap.json" |
| # offset,length from rowmap[<material_id>][<channel>] |
| # Range: bytes=<offset>-<offset+length-1> against base + "ambientcg-1k.tar" |
| ``` |
|
|
| ## Versioning |
|
|
| - **Dataset revisions:** calver — `v2026.05.0`, `v2026.06.0`, … |
| - **Client version:** semver — `mat-vis-client 0.5.x` targets HF substrate; `0.4.x` still works against the frozen `v2026.04.0` GitHub Release. |
|
|
| ## Contact |
|
|
| Issues, bugs, and feedback: |
| <https://github.com/MorePET/mat-vis/issues> |
|
|
