Update README.md (#5)

- Update README.md (9f4a0012d90ceea1b1ffaa79aab072be7f85a93c)


Co-authored-by: Kelli B <kellibelcher@users.noreply.huggingface.co>

README.md

@@ -1,55 +1,80 @@
 ---
-license: creativeml-openrail-m
-datasets:
-- laion/laion400m
-tags:
-- stable-diffusion
-- stable-diffusion-diffusers
-- text-to-image
 language:
-- en
+  - en
+tags:
+  - stable-diffusion
+  - stable-diffusion-diffusers
+  - text-to-image
+model-index:
+  - name: ldm3d
+    results:
+      - task:
+          name: Latent Diffusion Model for 3D
+          type: latent-diffusion-model-for-3D
+        dataset:
+          name: LAION-400M
+          type: laion/laion400m
+        metrics:
+          - name: FID
+            type: FID
+            value: 27.82
+          - name: IS
+            type: IS
+            value: 28.79
+          - name: CLIP
+            type: CLIP
+            value: 26.61
+          - name: AbsRel
+            type: AbsRel
+            value: 0.0911
+          - name: RMSE [m]
+            type: RMSE-m
+            value: 0.334
 pipeline_tag: text-to-3d
+license: creativeml-openrail-m
 ---
 
 # LDM3D model
 
-The LDM3D model was proposed in ["LDM3D: Latent Diffusion Model for 3D"](https://arxiv.org/abs/2305.10853) by Gabriela Ben Melech Stan, Diana Wofk, Scottie Fox, Alex Redden, Will Saxton, Jean Yu, Estelle Aflalo, Shao-Yen Tseng, Fabio Nonato, Matthias Muller, Vasudev Lal.
+The LDM3D model was proposed in the paper [LDM3D: Latent Diffusion Model for 3D](https://arxiv.org/abs/2305.10853.pdf), authored by Gabriela Ben Melech Stan, Diana Wofk, Scottie Fox, Alex Redden, Will Saxton, Jean Yu, Estelle Aflalo, Shao-Yen Tseng, Fabio Nonato, Matthias Muller, and Vasudev Lal.
 
-LDM3D got accepted to [CVPRW'23]([https://aaai.org/Conferences/AAAI-23/](https://cvpr2023.thecvf.com/)).
+LDM3D was accepted to the [IEEE / CVF Computer Vision and Pattern Recognition Conference (CVPR)](https://cvpr2023.thecvf.com/Conferences/2023) in 2023.
 
-For better results, do not hesitate to use [our new checkpoint](https://huggingface.co/Intel/ldm3d-4c) based on a slighlty different architecture.
+For better results, do not hesitate to use our new checkpoint, [ldm3d-4c](https://huggingface.co/Intel/ldm3d-4c) based on a slighlty different architecture.
 
-New checkpoints have been released:
-- [ldm3d-4c](https://huggingface.co/Intel/ldm3d-4c). A new version of LDM3D with higher quality results
-- [ldm3d-pano](https://huggingface.co/Intel/ldm3d-pano). LDM3D applied to panoramic images
-- [ldm3d-sr](https://huggingface.co/Intel/ldm3d-sr). Upscaler for LDM3D
+The following new LDM3D model checkpoints have been released:
+- [ldm3d-4c](https://huggingface.co/Intel/ldm3d-4c): A new version of LDM3D with higher quality results.
+- [ldm3d-pano](https://huggingface.co/Intel/ldm3d-pano): LDM3D applied to panoramic images.
+- [ldm3d-sr](https://huggingface.co/Intel/ldm3d-sr): Upscaler for LDM3D.
 
-## Model description
+## Model details
 
 The abstract from the paper is the following:
 This research paper proposes a Latent Diffusion Model for 3D (LDM3D) that generates both image and depth map data from a given text prompt, allowing users to generate RGBD images from text prompts. The LDM3D model is fine-tuned on a dataset of tuples containing an RGB image, depth map and caption, and validated through extensive experiments. We also develop an application called DepthFusion, which uses the img2img pipeline to create immersive and interactive 360-degree-view experiences using TouchDesigner. This technology has the potential to transform a wide range of industries, from entertainment and gaming to architecture and design. Overall, this paper presents a significant contribution to the field of generative AI and computer vision, and showcases the potential of LDM3D and DepthFusion to revolutionize content creation and digital experiences.
 
 ![LDM3D overview](model_overview.png)
-<font size="2">LDM3D overview taken from [the original paper](https://arxiv.org/abs/2305.10853)</font>
+<font size="2">LDM3D overview taken from the [LDM3D paper](https://arxiv.org/abs/2305.10853).</font>
 
-## Intended uses
+## Usage
 
-You can use this model to generate RGB and depth map given a text prompt.
+You can use this model to generate an RGB image and depth map given a text prompt.
 A short video summarizing the approach can be found at [this url](https://t.ly/tdi2) and a VR demo can be found [here](https://www.youtube.com/watch?v=3hbUo-hwAs0).
-A demo is also accessible on [Spaces](https://huggingface.co/spaces/Intel/ldm3d)
+A demo is also accessible on [Spaces](https://huggingface.co/spaces/Intel/ldm3d).
 
-### How to use
-
-Here is how to use this model to get the features of a given text in PyTorch:
+Here is how to use this model to get the features of a given text in PyTorch on both a CPU and GPU architecture:
 ```python
 
 from diffusers import StableDiffusionLDM3DPipeline
 
 pipe = StableDiffusionLDM3DPipeline.from_pretrained("Intel/ldm3d")
-pipe.to("cuda")
 
+# On CPU
+pipe.to("cpu")
+
+# On GPU
+pipe.to("cuda")
 
-prompt ="A picture of some lemons on a table"
+prompt = "A picture of some lemons on a table"
 name = "lemons"
 
 output = pipe(prompt)
@@ -62,13 +87,6 @@ This is the result:
 
 ![ldm3d_results](ldm3d_results.png)
 
-
-### Limitations and bias
-
-For the image generation, limitations and bias are the same as the ones from [Stable diffusion](https://huggingface.co/CompVis/stable-diffusion-v1-4#limitations)
-For the depth map generation, a first limitiation is that we are using DPT-large to produce the ground truth, hence, other limitations and bias are the same as the ones from [DPT](https://huggingface.co/Intel/dpt-large).
-
-
 ## Training data
 
 The LDM3D model was finetuned on a dataset constructed from a subset of the LAION-400M dataset, a large-scale image-caption dataset that contains over 400 million image-caption pairs.
@@ -79,9 +97,46 @@ The fine-tuning process comprises two stages. In the first stage, we train an au
 
 ## Evaluation results
 
-Please refer to Table 1 and Table2 from the [paper](https://arxiv.org/abs/2305.10853) for quantitative results.
-The figure below shows some qualitative results comparing our method with (Stable diffusion v1.4)[https://arxiv.org/pdf/2112.10752.pdf] and with (DPT-Large)[https://arxiv.org/pdf/2103.13413.pdf] for the depth maps
-![qualitative results](qualitative_results.png)
+### Quantitative results
+
+The table below shows the quantitative results of text-conditional image synthesis on the 512 x 512-sized MS-COCO dataset with 50 DDIM steps.
+
+|Method      |FID ↓|IS ↑        |CLIP ↑      |
+|------------|-----|------------|------------|
+|SD v1.4     |28.08|34.17 ± 0.76|26.13 ± 2.81|
+|SD v1.5     |27.39|34.02 ± 0.79|26.13 ± 2.79|
+|LDM3D (ours)|27.82|28.79 ± 0.49|26.61 ± 2.92|  
+
+Our model is on par with the Stable Diffusion models with the same number of parameters (1.06B). IS and CLIP similarity scores are averaged over 30k captions from the MS-COCO dataset.
+
+The following table shows the evaluation results of depth evaluation comparing LDM3D and DPT-Large with respect to ZoeDepth-N that serves as a reference model.
+
+|Method   |AbsRel|RMSE [m]|
+|---------|------|--------|
+|LDM3D    |0.0911|0.334   |
+|DPT-Large|0.0779|0.297   |
+
+The results shown above can be referenced in Table 1 and Table 2 of the [LDM3D paper](https://arxiv.org/abs/2305.10853.pdf).
+
+### Qualitative results
+
+The figure below shows some qualitative results comparing our method with [Stable Diffusion v1.4](https://arxiv.org/pdf/2112.10752.pdf) and with [DPT-Large](https://arxiv.org/pdf/2103.13413.pdf) for the depth maps ![qualitative results](qualitative_results.png).
+
+## Ethical Considerations and Limitations
+
+For image generation, the [Stable Diffusion](https://huggingface.co/CompVis/stable-diffusion-v1-4#limitations) limitations and biases apply. For depth map generation, a first limitiation is that we are using DPT-large to produce the ground truth, hence, other limitations and biases from [DPT](https://huggingface.co/Intel/dpt-large) are applicable.
+
+## Caveats and Recommendations
+
+Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model.
+
+Here are a couple of useful links to learn more about Intel's AI software:
+* [Intel Extension for PyTorch](https://github.com/intel/intel-extension-for-pytorch)
+* [Intel Neural Compressor](https://github.com/intel/neural-compressor)
+
+## Disclaimer
+
+The license on this model does not constitute legal advice. We are not responsible for the actions of third parties who use this model. Please cosult an attorney before using this model for commercial purposes.
 
 ### BibTeX entry and citation info
 ```bibtex