# LGM
LGM (Large Multi-View Gaussian Model) turns one picture of an object into 3D Gaussians in two stages: ImageDream samples four views around the object, then LGM reads them and returns the Gaussians. LibreYOLO runs both stages in plain PyTorch through the LibreGen factory.
Tasks: 3D generation. Install: pip install "libreyolo[gen]".
Verified against LibreYOLO v1.8.0.

## Install

```bash
pip install "libreyolo[gen]"
```

The extra brings `diffusers` and `transformers`, which load ImageDream's VAE,
scheduler and CLIP encoders.

## Predict

Nothing is gated and no login is needed. Weights download on first use at
pinned revisions.

**Python**

```python
from libreyolo import LibreGen, SAMPLE_IMAGE

model = LibreGen("lgm")             # weights download on first use
result = model(SAMPLE_IMAGE, seed=0)

result.save("object.ply")           # standard 3DGS layout
print(len(result.gaussians))        # those above opacity 0.005
```

**CLI**

```bash
# Saves the object as .ply under runs/generate/predict.
libreyolo generate source=https://raw.githubusercontent.com/LibreYOLO/libreyolo/release/libreyolo/assets/guggenheim-bilbao.jpg model=lgm seed=0
```

**Settings**

```python
from libreyolo import LibreGen, SAMPLE_IMAGE

model = LibreGen("lgm")
result = model(SAMPLE_IMAGE, elevation=-10)     # picture taken from above
result = model(SAMPLE_IMAGE, steps=20, guidance=1.0)   # no guidance
```

ImageDream, a multi-view diffusion model fine-tuned from Stable Diffusion
2.1, samples four views around the object from the 256 px input. LGM, an
asymmetric UNet with cross-view attention, reads the four views with their
camera rays and returns one Gaussian per output pixel of each view: 4 x 128 x
128 = 65,536 Gaussians, of which those above opacity 0.005 are kept, as
upstream saves them.

Upstream needs xformers on CUDA and renders with a non-commercial rasterizer.
LibreYOLO runs attention through PyTorch's SDPA and does not render, so the
model runs on NVIDIA GPUs, Apple silicon and CPU, in fp16 on GPUs and fp32 on
CPU. On CUDA a seed reproduces upstream's object; other devices draw other
noise for the same seed.

The output is `result.gaussians`, the same payload as
[Speridlabs Idol](/docs/models/speridlabs-idol), saved as `.ply` or
`.splat`.

### Settings

| Setting | Default | Meaning |
| --- | --- | --- |
| `steps` | `30` | ImageDream's DDIM sampling steps. |
| `guidance` | `5.0` | Classifier-free guidance; 1 turns it off. |
| `elevation` | `0` | Camera height of the picture in degrees; negative is above the object. |

## Variants

One size, `0.4b`: the 0.42B LGM network (about 0.8 GB) plus the 1.3B
ImageDream multi-view stage and its two CLIP encoders (about 4.0 GB).

## Export

| Task | ONNX | TorchScript | ExecuTorch | TensorRT | OpenVINO | Paddle | MNN | RKNN | Axelera | ncnn | TFLite | CoreML | Core AI |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
| 3D generation |  |  |  |  |  |  |  |  |  |  |  |  |  |

A "yes" means the export is supported. An empty cell means the exporter refuses that combination.

Export is not implemented for LibreGen 3D families. `export()`, `train()` and
`val()` raise `NotImplementedError` (ADR 0031 in the library).

## Licensing

Check the license on the Hugging Face repository of the specific weights you download. That repository is authoritative and licenses are not always uniform across a family. This is a description of the licenses involved, not legal advice.

- Original work: LGM, 3D Topia
- Upstream license: MIT and CreativeML OpenRAIL++-M
- Upstream source: https://github.com/3DTopia/LGM
- LibreYOLO code: MIT and Apache-2.0
- Weights: MIT and CreativeML OpenRAIL++-M, republished at https://huggingface.co/LibreYOLO
- Interpretation: LGM runs in two stages with different licenses. The LGM Gaussian model and its code are MIT, a permissive license that allows commercial and closed-source use with the copyright notice kept. The first stage, the ImageDream multi-view diffusion model (fine-tuned from MVDream and Stable Diffusion 2.1), is declared openrail upstream and LibreYOLO carries the CreativeML OpenRAIL++-M License of its Stable Diffusion 2.1 lineage: commercial use is allowed, but its use-based restrictions (no illegal, harmful, discriminatory or deceptive uses, among others) bind you and must be passed on to anyone you share the model or derivatives with. LibreYOLO's adapter is MIT; the code it adapts from LGM is MIT, with parts following ImageDream, the DINOv2 attention module and kiuikit under Apache-2.0, noted in libreyolo/models/gen/lgm/NOTICE. LibreYOLO leaves out upstream's renderer, which needs Inria's non-commercial Gaussian Splatting rasterizer. Weights are redistributed unchanged at pinned revisions: ashawkey/LGM with the BiRefNet weights (MIT) as LibreYOLO/LibreLGM0.4b, and ashawkey/imagedream-ipmv-diffusers as LibreYOLO/LibreImageDream; neither is gated.

LGM is by Jiaxiang Tang et al. at 3D Topia
([3DTopia/LGM](https://github.com/3DTopia/LGM)). The two stages carry
different licences:

- The LGM Gaussian model and its code are MIT.
- **ImageDream carries use restrictions.** It is declared OpenRAIL upstream,
  and LibreYOLO applies the CreativeML OpenRAIL++-M License of its Stable
  Diffusion 2.1 lineage: commercial use is allowed, but its use-based
  restrictions (no illegal, harmful, discriminatory or deceptive uses, among
  others) bind you and must be passed on with the model or derivatives.

Weights are redistributed unchanged at pinned revisions: `ashawkey/LGM` with
BiRefNet (MIT) as LibreYOLO/LibreLGM0.4b, and
`ashawkey/imagedream-ipmv-diffusers` as
[LibreYOLO/LibreImageDream](https://huggingface.co/LibreYOLO/LibreImageDream).
Neither is gated. Upstream's renderer, which needs Inria's non-commercial
rasterizer, is left out.

## Citation

```bibtex
@article{tang2024lgm,
  title={LGM: Large Multi-View Gaussian Model for High-Resolution 3D Content Creation},
  author={Tang, Jiaxiang and Chen, Zhaoxi and Chen, Xiaokang and Wang, Tengfei and Zeng, Gang and Liu, Ziwei},
  journal={arXiv preprint arXiv:2402.05054},
  year={2024}
}
```

Copied from https://github.com/3DTopia/LGM#citation
