update model cards

README.md

@@ -4,37 +4,69 @@ language:
 - en
 pipeline_tag: normals-estimation
 tags:
-- monocular normals estimation
-- single image normals estimation
-- normals
+- normals estimation
+- image analysis
+- computer vision
 - in-the-wild
 - zero-shot
 ---
-# Marigold Normals Model Card
 
-This model belongs to the family of diffusion-based Marigold models for solving various computer vision tasks.
-The Marigold Normals model focuses on the surface normals task.
-It takes an input image and computes surface normals in each pixel.
-The Marigold Normals model is trained from Stable Diffusion with synthetic data.
-Thanks to the rich visual knowledge stored in Stable Diffusion, Marigold models possess deep scene understanding and excel at solving computer vision tasks.
-Read more about Marigold in our paper titled "Repurposing Diffusion-Based Image Generators for Monocular Depth Estimation".
+<h1 align="center">Marigold Normals v0-1 Model Card</h1>
 
-[![Website](doc/badges/badge-website.svg)](https://marigoldmonodepth.github.io)
-[![GitHub](https://img.shields.io/github/stars/prs-eth/Marigold?style=default&label=GitHub%20★&logo=github)](https://github.com/prs-eth/Marigold)
-[![Paper](doc/badges/badge-pdf.svg)](https://arxiv.org/abs/2312.02145)
-[![Hugging Face Space](https://img.shields.io/badge/🤗%20Hugging%20Face-Space-yellow)](https://huggingface.co/spaces/toshas/marigold)
+<p align="center">
+<a title="Image Normals" href="https://huggingface.co/spaces/prs-eth/marigold-normals" target="_blank" rel="noopener noreferrer" style="display: inline-block;">
+    <img src="https://img.shields.io/badge/%F0%9F%A4%97%20Image%20Normals%20-Demo-yellow" alt="Image Normals">
+</a>
+<a title="diffusers" href="https://huggingface.co/docs/diffusers/using-diffusers/marigold_usage" target="_blank" rel="noopener noreferrer" style="display: inline-block;">
+    <img src="https://img.shields.io/badge/%F0%9F%A4%97%20diffusers%20-Integration%20🧨-yellow" alt="diffusers">
+</a>
+<a title="Github" href="https://github.com/prs-eth/marigold" target="_blank" rel="noopener noreferrer" style="display: inline-block;">
+    <img src="https://img.shields.io/github/stars/prs-eth/marigold?label=GitHub%20%E2%98%85&logo=github&color=C8C" alt="Github">
+</a>
+<a title="Website" href="https://marigoldcomputervision.github.io/" target="_blank" rel="noopener noreferrer" style="display: inline-block;">
+    <img src="https://img.shields.io/badge/%E2%99%A5%20Project%20-Website-blue" alt="Website">
+</a>
+<a title="arXiv" href="https://arxiv.org/abs/2312.02145" target="_blank" rel="noopener noreferrer" style="display: inline-block;">
+    <img src="https://img.shields.io/badge/%F0%9F%93%84%20Read%20-Paper-AF3436" alt="arXiv">
+</a>
+<a title="Social" href="https://twitter.com/antonobukhov1" target="_blank" rel="noopener noreferrer" style="display: inline-block;">
+    <img src="https://img.shields.io/twitter/follow/:?label=Subscribe%20for%20updates!" alt="Social">
+</a>
+<a title="License" href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="noopener noreferrer" style="display: inline-block;">
+    <img src="https://img.shields.io/badge/License-Apache--2.0-929292" alt="License">
+</a>
+</p>
 
-Developed by:
-[Bingxin Ke](http://www.kebingxin.com/),
-[Anton Obukhov](https://www.obukhov.ai/),
-[Shengyu Huang](https://shengyuh.github.io/),
-[Nando Metzger](https://nandometzger.github.io/),
-[Rodrigo Caye Daudt](https://rcdaudt.github.io/),
-[Konrad Schindler](https://scholar.google.com/citations?user=FZuNgqIAAAAJ&hl=en)
+<h2 align="center"><span style="color: red;"><b>This model is deprecated. Use the new Marigold Normals v1-1 Model instead.</b></span></h2>
+<h2 align="center">
+<a href="https://huggingface.co/prs-eth/marigold-normals-v1-1">NEW: Marigold Normals v1-1 Model</a>
+</h2>
 
-![teaser](doc/teaser_collage_transparant.png)
+This is a model card for the `marigold-normals-v0-1` model for monocular normals estimation from a single image. 
+The model is fine-tuned from the `stable-diffusion-2` [model](https://huggingface.co/stabilityai/stable-diffusion-2) as 
+described in 
+<span style="color:red;">a follow-up of our [CVPR'2024 paper](https://arxiv.org/abs/2312.02145) titled "Repurposing Diffusion-Based Image Generators for Monocular Depth Estimation".</span>
 
-## 🎓 Citation
+- Play with the interactive [Hugging Face Spaces demo](https://huggingface.co/spaces/prs-eth/marigold-normals): check out how the model works with example images or upload your own.
+- Use it with [diffusers](https://huggingface.co/docs/diffusers/using-diffusers/marigold_usage) to compute the results with a few lines of code.
+- Get to the bottom of things with our [official codebase](https://github.com/prs-eth/marigold).
+
+## Model Details
+- **Developed by:** [Bingxin Ke](http://www.kebingxin.com/), [Kevin Qu](https://ch.linkedin.com/in/kevin-qu-b3417621b), [Tianfu Wang](https://tianfwang.github.io/), [Nando Metzger](https://nandometzger.github.io/), [Shengyu Huang](https://shengyuh.github.io/), [Bo Li](https://www.linkedin.com/in/bobboli0202), [Anton Obukhov](https://www.obukhov.ai/), [Konrad Schindler](https://scholar.google.com/citations?user=FZuNgqIAAAAJ).
+- **Model type:** Generative latent diffusion-based normals estimation from a single image.
+- **Language:** English.
+- **License:** [Apache License License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
+- **Model Description:** This model can be used to generate an estimated surface normals map of an input image. 
+  - **Resolution**: Even though any resolution can be processed, the model inherits the base diffusion model's effective resolution of roughly **768** pixels. 
+    This means that for optimal predictions, any larger input image should be resized to make the longer side 768 pixels before feeding it into the model.
+  - **Steps and scheduler**: This model was designed for usage with **DDIM** scheduler and between **10 and 50** denoising steps.
+  - **Outputs**:
+    - **Surface normals map**: The predicted values are 3-dimensional unit vectors in the screen space camera.
+    - **Uncertainty map**: Produced only when multiple predictions are ensembled with ensemble size larger than 2.
+- **Resources for more information:** [Project Website](https://marigoldcomputervision.github.io/), [Paper](https://arxiv.org/abs/2312.02145), [Code](https://github.com/prs-eth/marigold).
+- **Cite as:**
+
+<span style="color:red;">Placeholder for the citation block of the follow-up paper</span>
 
 ```bibtex
 @InProceedings{ke2023repurposing,
@@ -44,11 +76,3 @@ Developed by:
       year={2024}
 }
 ```
-
-## 🎫 License
-
-This work is licensed under the Apache License, Version 2.0 (as defined in the [LICENSE](LICENSE.txt)).
-
-By downloading and using the code and model you agree to the terms in the [LICENSE](LICENSE.txt).
-
-[![License](https://img.shields.io/badge/License-Apache--2.0-929292)](https://www.apache.org/licenses/LICENSE-2.0)