-
Notifications
You must be signed in to change notification settings - Fork 217
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 3b5cd1e
Showing
22 changed files
with
2,679 additions
and
0 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all project spaces, and it also applies when | ||
an individual is representing the project or its community in public spaces. | ||
Examples of representing a project or community include using an official | ||
project e-mail address, posting via an official social media account, or acting | ||
as an appointed representative at an online or offline event. Representation of | ||
a project may be further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the open source team at [opensource-conduct@group.apple.com](mailto:opensource-conduct@group.apple.com). All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, | ||
available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Contribution Guide | ||
|
||
Thanks for your interest in contributing. This project was released to accompany a research paper for purposes of reproducibility, and beyond its publication there are limited plans for future development of the repository. | ||
|
||
While we welcome new pull requests and issues please note that our response may be limited. Forks and out-of-tree improvements are strongly encouraged. | ||
|
||
## Before you get started | ||
|
||
By submitting a pull request, you represent that you have the right to license your contribution to Apple and the community, and agree by submitting the patch that your contributions are licensed under the [LICENSE](LICENSE). | ||
|
||
We ask that all community members read and observe our [Code of Conduct](CODE_OF_CONDUCT.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
Copyright (C) 2024 Apple Inc. All Rights Reserved. | ||
|
||
Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple | ||
Inc. ("Apple") in consideration of your agreement to the following | ||
terms, and your use, installation, modification or redistribution of | ||
this Apple software constitutes acceptance of these terms. If you do | ||
not agree with these terms, please do not use, install, modify or | ||
redistribute this Apple software. | ||
|
||
In consideration of your agreement to abide by the following terms, and | ||
subject to these terms, Apple grants you a personal, non-exclusive | ||
license, under Apple's copyrights in this original Apple software (the | ||
"Apple Software"), to use, reproduce, modify and redistribute the Apple | ||
Software, with or without modifications, in source and/or binary forms; | ||
provided that if you redistribute the Apple Software in its entirety and | ||
without modifications, you must retain this notice and the following | ||
text and disclaimers in all such redistributions of the Apple Software. | ||
Neither the name, trademarks, service marks or logos of Apple Inc. may | ||
be used to endorse or promote products derived from the Apple Software | ||
without specific prior written permission from Apple. Except as | ||
expressly stated in this notice, no other rights or licenses, express or | ||
implied, are granted by Apple herein, including but not limited to any | ||
patent rights that may be infringed by your derivative works or by other | ||
works in which the Apple Software may be incorporated. | ||
|
||
The Apple Software is provided by Apple on an "AS IS" basis. APPLE | ||
MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION | ||
THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS | ||
FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND | ||
OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS. | ||
|
||
IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL | ||
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, | ||
MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED | ||
AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), | ||
STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE | ||
POSSIBILITY OF SUCH DAMAGE. | ||
|
||
|
||
------------------------------------------------------------------------------- | ||
SOFTWARE DISTRIBUTED IN THIS REPOSITORY: | ||
|
||
This software includes a number of subcomponents with separate | ||
copyright notices and license terms - please see the file ACKNOWLEDGEMENTS. | ||
------------------------------------------------------------------------------- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
## Depth Pro: Sharp Monocular Metric Depth in Less Than a Second | ||
|
||
This software project accompanies the research paper: | ||
**Depth Pro: Sharp Monocular Metric Depth in Less Than a Second**, | ||
*Aleksei Bochkovskii, Amaël Delaunoy, Hugo Germain, Marcel Santos, Yichao Zhou, Stephan R. Richter, and Vladlen Koltun*. | ||
|
||
![](data/depth-pro-teaser.jpg) | ||
|
||
We present a foundation model for zero-shot metric monocular depth estimation. Our model, Depth Pro, synthesizes high-resolution depth maps with unparalleled sharpness and high-frequency details. The predictions are metric, with absolute scale, without relying on the availability of metadata such as camera intrinsics. And the model is fast, producing a 2.25-megapixel depth map in 0.3 seconds on a standard GPU. These characteristics are enabled by a number of technical contributions, including an efficient multi-scale vision transformer for dense prediction, a training protocol that combines real and synthetic datasets to achieve high metric accuracy alongside fine boundary tracing, dedicated evaluation metrics for boundary accuracy in estimated depth maps, and state-of-the-art focal length estimation from a single image. | ||
|
||
|
||
The model in this repository is a reference implementation, which has been re-trained. Its performance is close to the model reported in the paper but does not match it exactly. | ||
|
||
## Getting Started | ||
|
||
We recommend setting up a virtual environment. Using e.g. miniconda, the `depth_pro` package can be installed via: | ||
|
||
```bash | ||
conda create -n depth-pro -y python=3.9 | ||
conda activate depth-pro | ||
|
||
pip install -e . | ||
``` | ||
|
||
To download pretrained checkpoints follow the code snippet below: | ||
```bash | ||
source get_pretrained_models.sh # Files will be downloaded to `checkpoints` directory. | ||
``` | ||
|
||
### Running from commandline | ||
|
||
We provide a helper script to directly run the model on a single image: | ||
```bash | ||
# Run prediction on a single image: | ||
depth-pro-run -i ./data/example.jpg | ||
# Run `depth-pro-run -h` for available options. | ||
``` | ||
|
||
### Running from python | ||
|
||
```python | ||
from PIL import Image | ||
import depth_pro | ||
|
||
# Load model and preprocessing transform | ||
model, transform = depth_pro.create_model_and_transforms() | ||
model.eval() | ||
|
||
# Load and preprocess an image. | ||
image, _, f_px = depth_pro.load_rgb(image_path) | ||
image = transform(image) | ||
|
||
# Run inference. | ||
prediction = model.infer(image, f_px=f_px) | ||
depth = prediction["depth"] # Depth in [m]. | ||
focallength_px = prediction["focallength_px"] # Focal length in pixels. | ||
``` | ||
|
||
|
||
### Evaluation (boundary metrics) | ||
|
||
Our boundary metrics can be found under `eval/boundary_metrics.py` and used as follows: | ||
|
||
```python | ||
# for a depth-based dataset | ||
boundary_f1 = SI_boundary_F1(predicted_depth, target_depth) | ||
|
||
# for a mask-based dataset (image matting / segmentation) | ||
boundary_recall = SI_boundary_Recall(predicted_depth, target_mask) | ||
``` | ||
|
||
|
||
## Citation | ||
|
||
If you find our work useful, please cite the following paper: | ||
|
||
```bibtex | ||
@article{Bochkovskii2024:arxiv, | ||
author = {Aleksei Bochkovskii and Ama\"{e}l Delaunoy and Hugo Germain and Marcel Santos and | ||
Yichao Zhou and Stephan R. Richter and Vladlen Koltun} | ||
title = {Depth Pro: Sharp Monocular Metric Depth in Less Than a Second}, | ||
journal = {arXiv}, | ||
year = {2024}, | ||
} | ||
``` | ||
|
||
## License | ||
This sample code is released under the [LICENSE](LICENSE) terms. | ||
|
||
The model weights are released under the [LICENSE](LICENSE) terms. | ||
|
||
## Acknowledgements | ||
|
||
Our codebase is built using multiple opensource contributions, please see [Acknowledgements](ACKNOWLEDGEMENTS.md) for more details. | ||
|
||
Please check the paper for a complete list of references and datasets used in this work. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
#!/usr/bin/env bash | ||
# | ||
# For licensing see accompanying LICENSE file. | ||
# Copyright (C) 2024 Apple Inc. All Rights Reserved. | ||
# | ||
mkdir -p checkpoints | ||
# Place final weights here: | ||
wget https://ml-site.cdn-apple.com/models/depth-pro/depth_pro.pt -P checkpoints |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
[project] | ||
name = "depth_pro" | ||
version = "0.1" | ||
description = "Inference/Network/Model code for Apple Depth Pro monocular depth estimation." | ||
readme = "README.md" | ||
dependencies = [ | ||
"torch", | ||
"torchvision", | ||
"timm", | ||
"numpy<2", | ||
"pillow_heif", | ||
"matplotlib", | ||
] | ||
|
||
[project.scripts] | ||
depth-pro-run = "depth_pro.cli:run_main" | ||
|
||
[project.urls] | ||
Homepage = "https://github.com/apple/ml-depth-pro" | ||
Repository = "https://github.com/apple/ml-depth-pro" | ||
|
||
[build-system] | ||
requires = ["setuptools", "setuptools-scm"] | ||
build-backend = "setuptools.build_meta" | ||
|
||
[tool.setuptools.packages.find] | ||
where = ["src"] | ||
|
||
[tool.pyright] | ||
include = ["src"] | ||
exclude = [ | ||
"**/node_modules", | ||
"**/__pycache__", | ||
] | ||
pythonVersion = "3.9" | ||
|
||
[tool.pytest.ini_options] | ||
minversion = "6.0" | ||
addopts = "-ra -q" | ||
testpaths = [ | ||
"tests" | ||
] | ||
filterwarnings = [ | ||
"ignore::DeprecationWarning" | ||
] | ||
|
||
[tool.lint.per-file-ignores] | ||
"__init__.py" = ["F401", "D100", "D104"] | ||
|
||
[tool.ruff] | ||
line-length = 100 | ||
lint.select = ["E", "F", "D", "I"] | ||
lint.ignore = ["D100", "D105"] | ||
extend-exclude = [ | ||
"*external*", | ||
"third_party", | ||
] | ||
src = ["depth_pro", "tests"] | ||
target-version = "py39" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Copyright (C) 2024 Apple Inc. All Rights Reserved. | ||
"""Depth Pro package.""" | ||
|
||
from .depth_pro import create_model_and_transforms # noqa | ||
from .utils import load_rgb # noqa |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Copyright (C) 2024 Apple Inc. All Rights Reserved. | ||
"""Depth Pro CLI and tools.""" | ||
|
||
from .run import main as run_main # noqa |
Oops, something went wrong.