AppledoreM commited on
Commit
40736b2
·
verified ·
1 Parent(s): 255626b

docs: add direct benchmark workflow

Browse files

Document the copy-paste download and 166-case runner command from the Mesh Untangling repository root.

Files changed (1) hide show
  1. README.md +17 -8
README.md CHANGED
@@ -24,8 +24,7 @@ It contains 166 input meshes:
24
  | Microsoft Rocketbox | 140 | OBJ and companion MTL | MIT |
25
 
26
  These are benchmark inputs and may contain self-intersections. They are not
27
- solver outputs and are unrelated to the separately announced intersection-free
28
- mesh dataset.
29
 
30
  ISIR, SMAL, and SCAPE are not included because their distribution terms require
31
  users to obtain the data from the respective owners.
@@ -46,18 +45,28 @@ SHA256SUMS
46
  `metadata/included-cases.json` records the 166 canonical OBJ paths and hashes.
47
  `SHA256SUMS` covers every distributed OBJ and MTL file.
48
 
49
- ## Download
 
 
 
 
50
 
51
  ```bash
52
  hf download AppledoreM/Mesh-Untangling-Benchmark \
53
  --repo-type dataset \
54
- --local-dir Mesh-Untangling-Benchmark
 
 
 
 
 
 
 
 
55
  ```
56
 
57
- To use these files with the release benchmark, copy the two directories under
58
- `data/` into the data root used by the Mesh Untangling repository. The remaining
59
- three datasets must be acquired separately before running the complete 343-case
60
- manifest.
61
 
62
  ## Integrity
63
 
 
24
  | Microsoft Rocketbox | 140 | OBJ and companion MTL | MIT |
25
 
26
  These are benchmark inputs and may contain self-intersections. They are not
27
+ solver outputs.
 
28
 
29
  ISIR, SMAL, and SCAPE are not included because their distribution terms require
30
  users to obtain the data from the respective owners.
 
45
  `metadata/included-cases.json` records the 166 canonical OBJ paths and hashes.
46
  `SHA256SUMS` covers every distributed OBJ and MTL file.
47
 
48
+ ## Download and run
49
+
50
+ Install the Hugging Face CLI if needed with
51
+ `python3 -m pip install --upgrade huggingface_hub`. From the Mesh Untangling
52
+ repository root, run:
53
 
54
  ```bash
55
  hf download AppledoreM/Mesh-Untangling-Benchmark \
56
  --repo-type dataset \
57
+ --local-dir benchmark-data
58
+
59
+ python3 scripts/run_untangle_benchmark.py \
60
+ --data-root benchmark-data/data \
61
+ --output-root output/public-benchmark \
62
+ --forward-flow-binary build/bin/Release/mesh-untangle \
63
+ --reverse-flow-binary build/bin/Release/reverse-flow \
64
+ --case 'math/*' \
65
+ --case 'Microsoft-Rocketbox/*'
66
  ```
67
 
68
+ Run from the Mesh Untangling repository root, keep the case globs quoted, and
69
+ choose an output directory that does not already exist.
 
 
70
 
71
  ## Integrity
72