|
| 1 | +<!--Copyright 2024 Marigold authors and The HuggingFace Team. All rights reserved. |
| 2 | +
|
| 3 | +Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
| 4 | +the License. You may obtain a copy of the License at |
| 5 | +
|
| 6 | +http://www.apache.org/licenses/LICENSE-2.0 |
| 7 | +
|
| 8 | +Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
| 9 | +an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
| 10 | +specific language governing permissions and limitations under the License. |
| 11 | +--> |
| 12 | + |
| 13 | +# Marigold Pipelines for Computer Vision Tasks |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | +Marigold was proposed in [Repurposing Diffusion-Based Image Generators for Monocular Depth Estimation](https://huggingface.co/papers/2312.02145), a CVPR 2024 Oral paper 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/), and [Konrad Schindler](https://scholar.google.com/citations?user=FZuNgqIAAAAJ&hl=en). |
| 18 | +The idea is to repurpose the rich generative prior of Text-to-Image Latent Diffusion Models (LDMs) for traditional computer vision tasks. |
| 19 | +Initially, this idea was explored to fine-tune Stable Diffusion for Monocular Depth Estimation, as shown in the teaser above. |
| 20 | +Later, |
| 21 | +- [Tianfu Wang](https://tianfwang.github.io/) trained the first Latent Consistency Model (LCM) of Marigold, which unlocked fast single-step inference; |
| 22 | +- [Kevin Qu](https://www.linkedin.com/in/kevin-qu-b3417621b/?locale=en_US) extended the approach to Surface Normals Estimation; |
| 23 | +- [Anton Obukhov](https://www.obukhov.ai/) contributed the pipelines and documentation into diffusers (enabled and supported by [YiYi Xu](https://yiyixuxu.github.io/) and [Sayak Paul](https://sayak.dev/)). |
| 24 | + |
| 25 | +The abstract from the paper is: |
| 26 | + |
| 27 | +*Monocular depth estimation is a fundamental computer vision task. Recovering 3D depth from a single image is geometrically ill-posed and requires scene understanding, so it is not surprising that the rise of deep learning has led to a breakthrough. The impressive progress of monocular depth estimators has mirrored the growth in model capacity, from relatively modest CNNs to large Transformer architectures. Still, monocular depth estimators tend to struggle when presented with images with unfamiliar content and layout, since their knowledge of the visual world is restricted by the data seen during training, and challenged by zero-shot generalization to new domains. This motivates us to explore whether the extensive priors captured in recent generative diffusion models can enable better, more generalizable depth estimation. We introduce Marigold, a method for affine-invariant monocular depth estimation that is derived from Stable Diffusion and retains its rich prior knowledge. The estimator can be fine-tuned in a couple of days on a single GPU using only synthetic training data. It delivers state-of-the-art performance across a wide range of datasets, including over 20% performance gains in specific cases. Project page: https://marigoldmonodepth.github.io.* |
| 28 | + |
| 29 | +## Available Pipelines |
| 30 | + |
| 31 | +Each pipeline supports one Computer Vision task, which takes an input RGB image as input and produces a *prediction* of the modality of interest, such as a depth map of the input image. |
| 32 | +Currently, the following tasks are implemented: |
| 33 | + |
| 34 | +| Pipeline | Predicted Modalities | Demos | |
| 35 | +|---------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------:| |
| 36 | +| [MarigoldDepthPipeline](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/marigold/pipeline_marigold_depth.py) | [Depth](https://en.wikipedia.org/wiki/Depth_map), [Disparity](https://en.wikipedia.org/wiki/Binocular_disparity) | [Fast Demo (LCM)](https://huggingface.co/spaces/prs-eth/marigold-lcm), [Slow Original Demo (DDIM)](https://huggingface.co/spaces/prs-eth/marigold) | |
| 37 | +| [MarigoldNormalsPipeline](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/marigold/pipeline_marigold_normals.py) | [Surface normals](https://en.wikipedia.org/wiki/Normal_mapping) | [Fast Demo (LCM)](https://huggingface.co/spaces/prs-eth/marigold-normals-lcm) | |
| 38 | + |
| 39 | + |
| 40 | +## Available Checkpoints |
| 41 | + |
| 42 | +The original checkpoints can be found under the [PRS-ETH](https://huggingface.co/prs-eth/) Hugging Face organization. |
| 43 | + |
| 44 | +<Tip> |
| 45 | + |
| 46 | +Make sure to check out the Schedulers [guide](../../using-diffusers/schedulers) to learn how to explore the tradeoff between scheduler speed and quality, and see the [reuse components across pipelines](../../using-diffusers/loading#reuse-components-across-pipelines) section to learn how to efficiently load the same components into multiple pipelines. Also, to know more about reducing the memory usage of this pipeline, refer to the ["Reduce memory usage"] section [here](../../using-diffusers/svd#reduce-memory-usage). |
| 47 | + |
| 48 | +</Tip> |
| 49 | + |
| 50 | +<Tip warning={true}> |
| 51 | + |
| 52 | +Marigold pipelines were designed and tested only with `DDIMScheduler` and `LCMScheduler`. |
| 53 | +Depending on the scheduler, the number of inference steps required to get reliable predictions varies, and there is no universal value that works best across schedulers. |
| 54 | +Because of that, the default value of `num_inference_steps` in the `__call__` method of the pipeline is set to `None` (see the API reference). |
| 55 | +Unless set explicitly, its value will be taken from the checkpoint configuration `model_index.json`. |
| 56 | +This is done to ensure high-quality predictions when calling the pipeline with just the `image` argument. |
| 57 | + |
| 58 | +</Tip> |
| 59 | + |
| 60 | +See also Marigold [usage examples](marigold_usage). |
| 61 | + |
| 62 | +## MarigoldDepthPipeline |
| 63 | +[[autodoc]] MarigoldDepthPipeline |
| 64 | + - all |
| 65 | + - __call__ |
| 66 | + |
| 67 | +## MarigoldNormalsPipeline |
| 68 | +[[autodoc]] MarigoldNormalsPipeline |
| 69 | + - all |
| 70 | + - __call__ |
| 71 | + |
| 72 | +## MarigoldDepthOutput |
| 73 | +[[autodoc]] pipelines.marigold.pipeline_marigold_depth.MarigoldDepthOutput |
| 74 | + |
| 75 | +## MarigoldNormalsOutput |
| 76 | +[[autodoc]] pipelines.marigold.pipeline_marigold_normals.MarigoldNormalsOutput |
0 commit comments