Link model card to Hugging Face paper page and add sample usage

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +24 -4
README.md CHANGED
@@ -1,11 +1,11 @@
1
  ---
2
  license: other
 
3
  tags:
4
  - text-to-3d
5
  - 3d-generation
6
  - checkpoint
7
  - geometry-conditioned-generation
8
- pipeline_tag: text-to-3d
9
  ---
10
 
11
  # Arbor
@@ -30,9 +30,29 @@ Please note: For individuals or organizations generating annual revenue of US $1
30
 
31
  - Repository: https://github.com/Stability-AI/arbor
32
  - Project page: https://arbor.jdihlmann.com/
33
- - Paper: https://arbor.jdihlmann.com/downloads/arbor_paper.pdf
 
 
 
 
34
 
35
- For installation, inference examples, evaluation, Blender notes, and demo assets, please use the [GitHub repository](https://github.com/Stability-AI/arbor).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
 
37
  ## Files
38
 
@@ -69,4 +89,4 @@ Arbor is not intended to generate factual representations of people, events, pro
69
 
70
  ## Safety
71
 
72
- Users should evaluate generated outputs for their own application constraints and apply additional mitigations where needed. Report safety issues to safety@stability.ai and security issues to security@stability.ai.
 
1
  ---
2
  license: other
3
+ pipeline_tag: text-to-3d
4
  tags:
5
  - text-to-3d
6
  - 3d-generation
7
  - checkpoint
8
  - geometry-conditioned-generation
 
9
  ---
10
 
11
  # Arbor
 
30
 
31
  - Repository: https://github.com/Stability-AI/arbor
32
  - Project page: https://arbor.jdihlmann.com/
33
+ - Paper: [Arbor: Explicit Geometric Conditioning for Controllable 3D Asset Generation](https://huggingface.co/papers/2606.23514)
34
+
35
+ For installation, evaluation, Blender notes, and demo assets, please use the [GitHub repository](https://github.com/Stability-AI/arbor).
36
+
37
+ ## Usage
38
 
39
+ Below is a simple example of using the Python API to run Arbor:
40
+
41
+ ```python
42
+ from pathlib import Path
43
+ from arbor import ArborPipeline, ConstraintSet
44
+
45
+ pipeline = ArborPipeline(model_dir="artifacts/model")
46
+ result = pipeline.run(
47
+ prompt="A small red toy piano with a rounded rectangular body.",
48
+ constraints=ConstraintSet(
49
+ hull=(Path("examples/constraints/piano__piano_038__8a941e90/hull_constraint.ply"),),
50
+ ),
51
+ output_dir="outputs/piano_038",
52
+ seed=1,
53
+ )
54
+ print(result.mesh_path)
55
+ ```
56
 
57
  ## Files
58
 
 
89
 
90
  ## Safety
91
 
92
+ Users should evaluate generated outputs for their own application constraints and apply additional mitigations where needed. Report safety issues to safety@stability.ai and security issues to security@stability.ai.