jdihlmann commited on
Commit ·
d45f0ac
1
Parent(s): 5890110
Simplify Arbor model card
Browse files- README.md +13 -67
- assets/demo_examples.png +0 -3
README.md
CHANGED
|
@@ -14,9 +14,7 @@ Explicit Geometric Conditioning for Controllable 3D Asset Generation
|
|
| 14 |
|
| 15 |

|
| 16 |
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
Arbor generates 3D assets from a text prompt and typed geometry constraints. Hull regions mark where geometry should exist, avoidance regions mark space that should stay empty, and touch regions mark surfaces the object should contact or keep reachable.
|
| 20 |
|
| 21 |
Please note: For individuals or organizations generating annual revenue of US $1,000,000 (or local currency equivalent) or more, regardless of the source of that revenue, you must obtain an enterprise commercial license directly from Stability AI before commercially using Arbor, derivative works of Arbor, or outputs from Arbor. See https://stability.ai/license and https://stability.ai/enterprise.
|
| 22 |
|
|
@@ -25,9 +23,16 @@ Please note: For individuals or organizations generating annual revenue of US $1
|
|
| 25 |
- Developed by: [Stability AI](https://stability.ai/)
|
| 26 |
- Authors: Jan-Niklas Dihlmann, Andreas Engelhardt, Simon Donne, Hendrik Lensch, Mark Boss
|
| 27 |
- Model type: Text and geometry constrained 3D generation model
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 28 |
- Repository: https://github.com/Stability-AI/arbor
|
| 29 |
- Project page: https://arbor.jdihlmann.com/
|
| 30 |
-
-
|
|
|
|
|
|
|
| 31 |
|
| 32 |
## Files
|
| 33 |
|
|
@@ -36,71 +41,12 @@ Please note: For individuals or organizations generating annual revenue of US $1
|
|
| 36 |
- `denoiser_ema0.9999_step0053000.pt`: public Arbor sparse-structure checkpoint.
|
| 37 |
- Optional parity artifact, if uploaded: `denoiser_step0053000.pt`.
|
| 38 |
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
## Quickstart
|
| 42 |
-
|
| 43 |
-
```bash
|
| 44 |
-
git clone https://github.com/Stability-AI/arbor.git
|
| 45 |
-
cd arbor
|
| 46 |
-
|
| 47 |
-
conda create -n arbor python=3.10 -y
|
| 48 |
-
conda activate arbor
|
| 49 |
-
conda install pytorch==2.4.0 torchvision==0.19.0 pytorch-cuda=11.8 -c pytorch -c nvidia -y
|
| 50 |
-
./setup.sh --basic --xformers --spconv
|
| 51 |
-
|
| 52 |
-
hf auth login
|
| 53 |
-
hf auth whoami
|
| 54 |
-
python scripts/download_model_from_hf.py --repo-id StabilityLabs/arbor --output-dir artifacts/model
|
| 55 |
-
python examples/run_manual_example.py --example chair_080 --output-root outputs/manual_examples --evaluate
|
| 56 |
-
```
|
| 57 |
-
|
| 58 |
-
For non-interactive shells, pass a token without saving it in shell history:
|
| 59 |
-
|
| 60 |
-
```bash
|
| 61 |
-
read -s HF_TOKEN
|
| 62 |
-
hf auth login --token "$HF_TOKEN"
|
| 63 |
-
unset HF_TOKEN
|
| 64 |
-
hf auth whoami
|
| 65 |
-
```
|
| 66 |
-
|
| 67 |
-
## Demo Examples
|
| 68 |
-
|
| 69 |
-
The GitHub release includes curated constraint meshes and a public evaluator that renders condition-following panels.
|
| 70 |
-
|
| 71 |
-

|
| 72 |
-
|
| 73 |
-
Run the examples with:
|
| 74 |
-
|
| 75 |
-
```bash
|
| 76 |
-
python examples/run_manual_example.py --example bus_013 --output-root outputs/manual_examples --evaluate
|
| 77 |
-
python examples/run_manual_example.py --example chair_080 --output-root outputs/manual_examples --evaluate
|
| 78 |
-
python examples/run_manual_example.py --example piano_038 --output-root outputs/manual_examples --evaluate
|
| 79 |
-
python examples/run_manual_example.py --example sink_015 --output-root outputs/manual_examples --evaluate
|
| 80 |
-
```
|
| 81 |
-
|
| 82 |
-
## Evaluation Outputs
|
| 83 |
-
|
| 84 |
-
The public `arbor-evaluate` command computes condition metrics and renders inspection panels without training code or benchmark launchers.
|
| 85 |
-
|
| 86 |
-
```bash
|
| 87 |
-
arbor-evaluate \
|
| 88 |
-
--prediction outputs/manual_examples/bus_013/mesh.ply \
|
| 89 |
-
--hull examples/constraints/bus__bus_013__19cbb410/hull_constraint.ply \
|
| 90 |
-
--avoidance examples/constraints/bus__bus_013__19cbb410/avoidance_constraint.ply \
|
| 91 |
-
--touch examples/constraints/bus__bus_013__19cbb410/touchable_constraint.ply \
|
| 92 |
-
--reference-mesh examples/constraints/bus__bus_013__19cbb410/gt_mesh.ply \
|
| 93 |
-
--sparse-structure outputs/manual_examples/bus_013/ss_surface.npz \
|
| 94 |
-
--output-dir outputs/manual_examples/bus_013/evaluation
|
| 95 |
-
```
|
| 96 |
-
|
| 97 |
-
`--reference-mesh` is optional. It adds reference metrics such as Chamfer distance and F-score. It is not used for generation.
|
| 98 |
-
|
| 99 |
-
The evaluator writes `metrics.json`, `metrics_flat.json`, and a four-view `condition_panel.png`. Pass `--save-gif` to also write `condition_orbit.gif`; the default speed is 150 ms per frame.
|
| 100 |
|
| 101 |
-
|
|
|
|
| 102 |
|
| 103 |
-
|
| 104 |
|
| 105 |
## Intended Uses
|
| 106 |
|
|
|
|
| 14 |
|
| 15 |

|
| 16 |
|
| 17 |
+
Arbor is a text-to-3D generation model with explicit geometry controls. It accepts a prompt and typed constraint meshes for hull, avoidance, and touch regions.
|
|
|
|
|
|
|
| 18 |
|
| 19 |
Please note: For individuals or organizations generating annual revenue of US $1,000,000 (or local currency equivalent) or more, regardless of the source of that revenue, you must obtain an enterprise commercial license directly from Stability AI before commercially using Arbor, derivative works of Arbor, or outputs from Arbor. See https://stability.ai/license and https://stability.ai/enterprise.
|
| 20 |
|
|
|
|
| 23 |
- Developed by: [Stability AI](https://stability.ai/)
|
| 24 |
- Authors: Jan-Niklas Dihlmann, Andreas Engelhardt, Simon Donne, Hendrik Lensch, Mark Boss
|
| 25 |
- Model type: Text and geometry constrained 3D generation model
|
| 26 |
+
- Model details: Arbor generates a geometry-conditioned sparse structure that is decoded into a mesh with the TRELLIS SLAT mesh decoder.
|
| 27 |
+
- Base stack: TRELLIS text-to-3D and TRELLIS.2 constraint encoding components
|
| 28 |
+
|
| 29 |
+
## Model Sources
|
| 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 |
|
|
|
|
| 41 |
- `denoiser_ema0.9999_step0053000.pt`: public Arbor sparse-structure checkpoint.
|
| 42 |
- Optional parity artifact, if uploaded: `denoiser_step0053000.pt`.
|
| 43 |
|
| 44 |
+
## License
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 45 |
|
| 46 |
+
- Community License: Free for research, non-commercial, and commercial use by organizations and individuals generating annual revenue of US $1,000,000 (or local currency equivalent) or less, regardless of the source of that revenue.
|
| 47 |
+
- If your annual revenue exceeds US $1M, any commercial use of this model or derivative works requires an Enterprise License directly from Stability AI.
|
| 48 |
|
| 49 |
+
Please refer to Stability AI's Community License at https://stability.ai/license for more information.
|
| 50 |
|
| 51 |
## Intended Uses
|
| 52 |
|
assets/demo_examples.png
DELETED
Git LFS Details
|