AppledoreM's picture
docs: add direct benchmark workflow
40736b2 verified
|
Raw
History Blame Contribute Delete
2.16 kB
metadata
pretty_name: Mesh Untangling Benchmark
license:
  - apache-2.0
  - mit
tags:
  - 3d
  - mesh
  - geometry-processing
  - self-intersection
size_categories:
  - n<1K

Mesh Untangling Benchmark

This repository contains the publicly redistributable portion of the benchmark used by Mesh Untangling. It contains 166 input meshes:

Dataset Cases Files License
Analytic Surfaces (math) 26 OBJ Apache-2.0
Microsoft Rocketbox 140 OBJ and companion MTL MIT

These are benchmark inputs and may contain self-intersections. They are not solver outputs.

ISIR, SMAL, and SCAPE are not included because their distribution terms require users to obtain the data from the respective owners.

Layout

data/
├── math/
└── Microsoft-Rocketbox/
licenses/
metadata/
└── included-cases.json
PROVENANCE.md
SHA256SUMS

metadata/included-cases.json records the 166 canonical OBJ paths and hashes. SHA256SUMS covers every distributed OBJ and MTL file.

Download and run

Install the Hugging Face CLI if needed with python3 -m pip install --upgrade huggingface_hub. From the Mesh Untangling repository root, run:

hf download AppledoreM/Mesh-Untangling-Benchmark \
  --repo-type dataset \
  --local-dir benchmark-data

python3 scripts/run_untangle_benchmark.py \
  --data-root benchmark-data/data \
  --output-root output/public-benchmark \
  --forward-flow-binary build/bin/Release/mesh-untangle \
  --reverse-flow-binary build/bin/Release/reverse-flow \
  --case 'math/*' \
  --case 'Microsoft-Rocketbox/*'

Run from the Mesh Untangling repository root, keep the case globs quoted, and choose an output directory that does not already exist.

Integrity

From the downloaded repository root:

sha256sum --check SHA256SUMS

Licensing and provenance

The Analytic Surfaces meshes are released under Apache-2.0. The selected Microsoft Rocketbox assets and their derived benchmark exports retain Microsoft's MIT license and copyright notice. See licenses/ and PROVENANCE.md for details.