Update README.md (#2)

- Update README.md (9235b96fb11ac6b5711eb462817f9fc9820198b3)


Co-authored-by: Kelli B <[email protected]>

README.md

@@ -1,27 +1,58 @@
 ---
+language:
+  - en
+tags:
+  - stable-diffusion
+  - stable-diffusion-diffusers
+  - text-to-image
+model-index:
+  - name: ldm3d-sr
+    results:
+      - task:
+          name: Latent Diffusion Model for 3D - Super-Resolution
+          type: latent-diffusion-model-for-3D-SR
+        dataset:
+          name: LAION-400M
+          type: laion/laion400m
+        metrics:
+          - name: LDM3D-SR-B FID
+            type: LDM3D-SR-B FID
+            value: 14.705
+          - name: LDM3D-SR-B IS
+            type: LDM3D-SR-B IS
+            value: 60.371
+          - name: LDM3D-SR-B PSNR
+            type: LDM3D-SR-B PSNR
+            value: 24.479
+          - name: LDM3D-SR-B SSIM
+            type: LDM3D-SR-B SSIM
+            value: 0.665
+          - name: LDM3D-SR-B Depth MARE
+            type: LDM3D-SR-B Depth MARE
+            value: 0.0537
 library_name: diffusers
-pipeline_tag: image-to-image
+pipeline_tag: text-to-3d
+license: creativeml-openrail-m
 ---
 
-# LDM3D-VR model
+# LDM3D-SR model
 
-The LDM3D-VR model was proposed in ["LDM3D-VR: Latent Diffusion Model for 3D"](https://arxiv.org/pdf/2311.03226.pdf) by Gabriela Ben Melech Stan, Diana Wofk, Estelle Aflalo, Shao-Yen Tseng, Zhipeng Cai, Michael Paulitsch, Vasudev Lal.
+The LDM3D-VR model suite was proposed in the paper [LDM3D-VR: Latent Diffusion Model for 3D](https://arxiv.org/pdf/2311.03226.pdf), authored by Gabriela Ben Melech Stan, Diana Wofk, Estelle Aflalo, Shao-Yen Tseng, Zhipeng Cai, Michael Paulitsch, and Vasudev Lal.  
 
-LDM3D-VR got accepted to [NeurIPS Workshop'23 on Diffusion Models][https://neurips.cc/virtual/2023/workshop/66539].
+LDM3D-VR was accepted to the [NeurIPS 2023 Workshop on Diffusion Models](https://neurips.cc/virtual/2023/workshop/66539).
 
-This new checkpoint related to the upscaler called ldm3d-sr.
+This new checkpoint is related to the upscaler called LDM3D-SR.
 
-# Model description
-The abstract from the paper is the following: Latent diffusion models have proven to be state-of-the-art in the creation and manipulation of visual outputs. However, as far as we know, the generation of depth maps jointly with RGB is still limited. We introduce LDM3D-VR, a suite of diffusion models targeting virtual reality development that includes LDM3D-pano
-and LDM3D-SR. These models enable the generation of panoramic RGBD based on textual prompts and the upscaling of low-resolution inputs to high-resolution RGBD, respectively. Our models are fine-tuned from existing pretrained models on datasets containing panoramic/high-resolution RGB images, depth maps and captions. Both models are evaluated in comparison to existing related methods. 
+## Model details
+Latent diffusion models have proven to be state-of-the-art in the creation and manipulation of visual outputs. However, as far as we know, the generation of depth maps jointly with RGB is still limited. We introduce LDM3D-VR, a suite of diffusion models targeting virtual reality development that includes LDM3D-pano and LDM3D-SR. These models enable the generation of panoramic RGBD based on textual prompts and the upscaling of low-resolution inputs to high-resolution RGBD, respectively. Our models are fine-tuned from existing pretrained models on datasets containing panoramic/high-resolution RGB images, depth maps and captions. Both models are evaluated in comparison to existing related methods. 
 
 ![LDM3D-SR overview](ldm3d-sr-overview.png)
 <font size="2">LDM3D-SR overview </font>
 
 
-## Examples
+## Usage
 
-Using the [🤗's Diffusers library](https://github.com/huggingface/diffusers) in a simple and efficient manner.
+Using the [🤗's Diffusers library](https://github.com/huggingface/diffusers) in a simple and efficient manner. 
 
 ```python
 from PIL import Image
@@ -54,17 +85,57 @@ upscaled_rgb.save(f"upscaled_lemons_rgb.png")
 upscaled_depth.save(f"upscaled_lemons_depth.png")
 ```
 
-
-## Results
+This is the result:
 
 Output of ldm3d-4c          |  Upscaled output
 :-------------------------:|:-------------------------:
 ![ldm3d_rgb_results](lemons_ldm3d_rgb.jpg)  |  ![ldm3d_sr_rgb_results](upscaled_lemons_rgb.png)
 ![ldm3d_depth_results](lemons_ldm3d_depth.png)  |  ![ldm3d_sr_depth_results](upscaled_lemons_depth.png)
 
+## 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. In the finetuning process of the LDM3D-SR, the training data consists of additional high-resolution (HR) and low-resolution (LR) sets with 261,045 samples each. For HR samples, a subset of LAION Aesthetics 6+ with tuples (captions, 512x512-sized images, and depth maps from DPT-BEiT-L-512) is used. LR images are generated using a lightweight BSR-image-degradation method, introduced in applied to the HR image. 
+
+### Finetuning
+
+The fine-tuning process comprises two stages. In the first stage, we train an autoencoder to generate a lower-dimensional, perceptually equivalent data representation. Subsequently, we fine-tune the diffusion model using the frozen autoencoder.
+
+LDM3D-SR utilizes the autoencoder previously developed for [LDM3D-4c](https://huggingface.co/Intel/ldm3d-4c) to now encode low-resolution (LR) images into a 64x64x4 dimensional latent space. The diffusion model used here is an adapted version of the U-Net, now modified to have an 8-channel input. This change enables conditioning on LR latent via concatenation to the high-resolution (HR) latent during training, and to noise during inference. Text conditioning is also facilitated using cross attention with a CLIP text encoder. 
+
+## Evaluation results
+
+The table below shows the quantitative results of upscaling from 128 x 128 to 512 x 512, evaluated on 2,243 samples from ImageNet-Val. We explore three methods for generating LR depth maps: performing depth estimation on the LR depth maps (LDM3D-SR-D), utilizing the original HR depth map for LR conditioning (LDM3D-SR-O), and applying bicubic degradation to the depth map (LDM3D-SR-B).
+
+|Method             |FID ↓ |IS ↑       |PSNR ↑     |SSIM ↑    |Depth MARE ↓ |
+|-------------------|------|-----------|-----------|----------|-------------|
+|Regression, bicubic|24.686|60.135±4.16|26.424±3.98|0.716±0.13|0.0153±0.0189|
+|SDx4[29]           |15.865|61.103±3.48|24.528±3.63|0.631±0.15|N/A          |
+|LDMx4[30]          |15.245|60.060±3.88|25.511±3.94|0.686±0.16|N/A          |
+|SD-superres[2]     |15.254|59.789±3.53|23.878±3.28|0.642±0.15|N/A          |
+|LDM3D-SR-D         |15.522|59.736±3.37|24.113±3.54|0.659±0.16|0.0753±0.0734|
+|LDM3D-SR-O         |14.793|60.260±3.53|24.498±3.59|0.665±0.16|0.0530±0.0496|
+|LDM3D-SR-B         |14.705|60.371±3.56|24.479±3.58|0.665±0.48|0.0537±0.0506|
+
+The results shown above can be referenced in Table 3 of the [LDM3D-VR paper](https://arxiv.org/pdf/2311.03226.pdf).
+
+## 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 consult an attorney before using this model for commercial purposes.
 
 ### BibTeX entry and citation info
+```bibtex
 @misc{stan2023ldm3dvr,
       title={LDM3D-VR: Latent Diffusion Model for 3D VR}, 
       author={Gabriela Ben Melech Stan and Diana Wofk and Estelle Aflalo and Shao-Yen Tseng and Zhipeng Cai and Michael Paulitsch and Vasudev Lal},
@@ -72,4 +143,5 @@ Output of ldm3d-4c          |  Upscaled output
       eprint={2311.03226},
       archivePrefix={arXiv},
       primaryClass={cs.CV}
-}
+}
+```