Duplicate from openai/shap-e

Co-authored-by: Patrick von Platen <patrickvonplaten@users.noreply.huggingface.co>

.gitattributes

@@ -0,0 +1,34 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,107 @@
+---
+license: mit
+tags:
+- text-to-image
+- shap-e
+- diffusers
+pipeline_tag: text-to-3d
+---
+
+# Shap-E
+
+Shap-E introduces a diffusion process that can generate a 3D image from a text prompt. It was introduced in [Shap-E: Generating Conditional 3D Implicit Functions](https://arxiv.org/abs/2305.02463) by Heewoo Jun and Alex Nichol from OpenAI. 
+
+Original repository of Shap-E can be found here: https://github.com/openai/shap-e. 
+
+_The authors of Shap-E didn't author this model card. They provide a separate model card [here](https://github.com/openai/shap-e/blob/main/model-card.md)._
+
+## Introduction 
+
+The abstract of the Shap-E paper:
+
+*We present Shap-E, a conditional generative model for 3D assets. Unlike recent work on 3D generative models which produce a single output representation, Shap-E directly generates the parameters of implicit functions that can be rendered as both textured meshes and neural radiance fields. We train Shap-E in two stages: first, we train an encoder that deterministically maps 3D assets into the parameters of an implicit function; second, we train a conditional diffusion model on outputs of the encoder. When trained on a large dataset of paired 3D and text data, our resulting models are capable of generating complex and diverse 3D assets in a matter of seconds. When compared to Point-E, an explicit generative model over point clouds, Shap-E converges faster and reaches comparable or better sample quality despite modeling a higher-dimensional, multi-representation output space. We release model weights, inference code, and samples at [this https URL](https://github.com/openai/shap-e).*
+
+## Released checkpoints
+
+The authors released the following checkpoints:
+
+* [openai/shap-e](https://hf.co/openai/shap-e): produces a 3D image from a text input prompt
+* [openai/shap-e-img2img](https://hf.co/openai/shap-e-img2img): samples a 3D image from synthetic 2D image
+
+## Usage examples in 🧨 diffusers
+
+First make sure you have installed all the dependencies:
+
+```bash 
+pip install transformers accelerate -q
+pip install git+https://github.com/huggingface/diffusers@@shap-ee
+```
+
+Once the dependencies are installed, use the code below:
+
+```python 
+import torch
+from diffusers import ShapEPipeline
+from diffusers.utils import export_to_gif
+
+
+ckpt_id = "openai/shap-e"
+pipe = ShapEPipeline.from_pretrained(repo).to("cuda")
+
+
+guidance_scale = 15.0
+prompt = "a shark"
+images = pipe(
+    prompt,
+    guidance_scale=guidance_scale,
+    num_inference_steps=64,
+    size=256,
+).images
+
+gif_path = export_to_gif(images, "shark_3d.gif")
+```
+
+## Results 
+
+<table>
+    <tbody>
+        <tr>
+            <td align="center">
+                <img src="https://huggingface.co/datasets/diffusers/docs-images/resolve/main/shap-e/bird_3d.gif" alt="a bird">
+            </td>
+            <td align="center">
+                <img src="https://huggingface.co/datasets/diffusers/docs-images/resolve/main/shap-e/shark_3d.gif" alt="a shark">
+            </td align="center">
+            <td align="center">
+                <img src="https://huggingface.co/datasets/diffusers/docs-images/resolve/main/shap-e/veg_3d.gif" alt="A bowl of vegetables">
+            </td>
+        </tr>
+        <tr>
+            <td align="center">A bird</td>
+            <td align="center">A shark</td>
+            <td align="center">A bowl of vegetables</td>
+        </tr>
+     </tr> 
+    </tbody>
+<table>
+
+## Training details
+
+Refer to the [original paper](https://arxiv.org/abs/2305.02463).
+
+## Known limitations and potential biases
+    
+Refer to the [original model card](https://github.com/openai/shap-e/blob/main/model-card.md).
+    
+## Citation
+
+```bibtex 
+@misc{jun2023shape,
+      title={Shap-E: Generating Conditional 3D Implicit Functions}, 
+      author={Heewoo Jun and Alex Nichol},
+      year={2023},
+      eprint={2305.02463},
+      archivePrefix={arXiv},
+      primaryClass={cs.CV}
+}
+```

model_index.json

@@ -0,0 +1,28 @@
+{
+  "_class_name": "ShapEPipeline",
+  "_diffusers_version": "0.17.0.dev0",
+  "scheduler": [
+    "diffusers",
+    "HeunDiscreteScheduler"
+  ],
+  "text_encoder": [
+    "transformers",
+    "CLIPTextModelWithProjection"
+  ],
+  "tokenizer": [
+    "transformers",
+    "CLIPTokenizer"
+  ],
+  "prior": [
+    "diffusers",
+    "PriorTransformer"
+  ],
+  "renderer": [
+    "shap_e",
+    "ShapERenderer"
+  ],
+  "shap_e_renderer": [
+    "shap_e",
+    "ShapERenderer"
+  ]
+}

prior/config.json

@@ -0,0 +1,19 @@
+{
+  "_class_name": "PriorTransformer",
+  "_diffusers_version": "0.18.0.dev0",
+  "added_emb_type": null,
+  "additional_embeddings": 0,
+  "attention_head_dim": 64,
+  "clip_embed_dim": 2048,
+  "dropout": 0.0,
+  "embedding_dim": 1024,
+  "embedding_proj_dim": 768,
+  "embedding_proj_norm_type": null,
+  "encoder_hid_proj_type": null,
+  "norm_in_type": "layer",
+  "num_attention_heads": 16,
+  "num_embeddings": 1024,
+  "num_layers": 24,
+  "time_embed_act_fn": "gelu",
+  "time_embed_dim": 4096
+}

prior/diffusion_pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:df21cb49c7f10eb02f6ce485a59c86601d03707b80d715335f0be6be89b1226e
+size 1262937295

prior/diffusion_pytorch_model.fp16.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:04ad95e7374796a817f5b5a32b885be457b013ffdadf5da2f99883886f417aac
+size 631435880

renderer/config.json

@@ -0,0 +1,34 @@
+{
+  "_class_name": "ShapERenderer",
+  "_diffusers_version": "0.18.0.dev0",
+  "act_fn": "swish",
+  "d_hidden": 256,
+  "d_latent": 1024,
+  "insert_direction_at": 4,
+  "n_hidden_layers": 6,
+  "n_output": 12,
+  "param_names": [
+    "nerstf.mlp.0.weight",
+    "nerstf.mlp.1.weight",
+    "nerstf.mlp.2.weight",
+    "nerstf.mlp.3.weight"
+  ],
+  "param_shapes": [
+    [
+      256,
+      93
+    ],
+    [
+      256,
+      256
+    ],
+    [
+      256,
+      256
+    ],
+    [
+      256,
+      256
+    ]
+  ]
+}

renderer/diffusion_pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2751cbad694f7fef9022f88673c065df49283d977ff93e88e133f3585e2dfd28
+size 905200536

renderer/diffusion_pytorch_model.fp16.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:394d52e159447b2bfb944d3bfa4f438180b72ba40644dc4c730282e7a9b62c65
+size 452597858

scheduler/scheduler_config.json

@@ -0,0 +1,11 @@
+{
+  "_class_name": "HeunDiscreteScheduler",
+  "_diffusers_version": "0.17.0.dev0",
+  "beta_schedule": "exp",
+  "trained_betas": null,
+  "num_train_timesteps": 1024,
+  "clip_sample": true,
+  "clip_sample_range": 1.0,
+  "prediction_type": "sample",
+  "use_karras_sigmas": true
+}

shap_e_renderer/config.json

@@ -0,0 +1,39 @@
+{
+  "_class_name": "ShapERenderer",
+  "_diffusers_version": "0.19.0.dev0",
+  "act_fn": "swish",
+  "background": [
+    255.0,
+    255.0,
+    255.0
+  ],
+  "d_hidden": 256,
+  "d_latent": 1024,
+  "insert_direction_at": 4,
+  "n_hidden_layers": 6,
+  "n_output": 12,
+  "param_names": [
+    "nerstf.mlp.0.weight",
+    "nerstf.mlp.1.weight",
+    "nerstf.mlp.2.weight",
+    "nerstf.mlp.3.weight"
+  ],
+  "param_shapes": [
+    [
+      256,
+      93
+    ],
+    [
+      256,
+      256
+    ],
+    [
+      256,
+      256
+    ],
+    [
+      256,
+      256
+    ]
+  ]
+}

shap_e_renderer/diffusion_pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2b63c2b52fbff7cc2c0b88b196f169e8adbcc2c298cadab30afe63c8a7241a05
+size 905233202

text_encoder/config.json

@@ -0,0 +1,25 @@
+{
+  "_name_or_path": "openai/clip-vit-large-patch14",
+  "architectures": [
+    "CLIPTextModelWithProjection"
+  ],
+  "attention_dropout": 0.0,
+  "bos_token_id": 0,
+  "dropout": 0.0,
+  "eos_token_id": 2,
+  "hidden_act": "quick_gelu",
+  "hidden_size": 768,
+  "initializer_factor": 1.0,
+  "initializer_range": 0.02,
+  "intermediate_size": 3072,
+  "layer_norm_eps": 1e-05,
+  "max_position_embeddings": 77,
+  "model_type": "clip_text_model",
+  "num_attention_heads": 12,
+  "num_hidden_layers": 12,
+  "pad_token_id": 1,
+  "projection_dim": 768,
+  "torch_dtype": "float32",
+  "transformers_version": "4.29.2",
+  "vocab_size": 49408
+}

text_encoder/model.fp16.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fc42badf529dd83f2f7c3d20fe6bda1e22036162f37c4c668b9e130884e20561
+size 247324608

text_encoder/pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:85f5bcf101dde33d8ab9f7e5e1678339fa4258ea07bc65e6ca66e01f9de99622
+size 494664885

tokenizer/special_tokens_map.json

@@ -0,0 +1,24 @@
+{
+  "bos_token": {
+    "content": "<|startoftext|>",
+    "lstrip": false,
+    "normalized": true,
+    "rstrip": false,
+    "single_word": false
+  },
+  "eos_token": {
+    "content": "<|endoftext|>",
+    "lstrip": false,
+    "normalized": true,
+    "rstrip": false,
+    "single_word": false
+  },
+  "pad_token": "<|endoftext|>",
+  "unk_token": {
+    "content": "<|endoftext|>",
+    "lstrip": false,
+    "normalized": true,
+    "rstrip": false,
+    "single_word": false
+  }
+}

tokenizer/tokenizer_config.json

@@ -0,0 +1,33 @@
+{
+  "add_prefix_space": false,
+  "bos_token": {
+    "__type": "AddedToken",
+    "content": "<|startoftext|>",
+    "lstrip": false,
+    "normalized": true,
+    "rstrip": false,
+    "single_word": false
+  },
+  "clean_up_tokenization_spaces": true,
+  "do_lower_case": true,
+  "eos_token": {
+    "__type": "AddedToken",
+    "content": "<|endoftext|>",
+    "lstrip": false,
+    "normalized": true,
+    "rstrip": false,
+    "single_word": false
+  },
+  "errors": "replace",
+  "model_max_length": 77,
+  "pad_token": "<|endoftext|>",
+  "tokenizer_class": "CLIPTokenizer",
+  "unk_token": {
+    "__type": "AddedToken",
+    "content": "<|endoftext|>",
+    "lstrip": false,
+    "normalized": true,
+    "rstrip": false,
+    "single_word": false
+  }
+}