.. image:: https://github.com/deepinv/deepinv/raw/main/docs/source/figures/deepinv_logolarge.png :width: 500px :alt: deepinv logo :align: center

|pip install| |stars| |discord| |colab| |youtube| |paper|

|测试状态| |GPU测试状态| |文档状态| |GPU文档状态| |Python版本| |Black| |codecov|

简介

DeepInverse <https://deepinv.github.io/deepinv>_ 是一个基于 PyTorch 的开源库，用于通过深度学习求解成像逆问题。该库是 官方 PyTorch 生态系统 <https://pytorch.landscape2.io/?item=modeling--computer-vision--deepinverse>_ 的一部分。deepinv 加速了跨成像领域的深度学习研究，通过通用的模块化问题和算法框架提高了研究的可重复性，并降低了新从业者入门的门槛。

.. image:: https://github.com/deepinv/deepinv/raw/main/docs/source/figures/deepinv_schematic.png :width: 1000px :alt: deepinv 示意图 :align: center

开始使用

请在 deepinv.github.io <https://deepinv.github.io>_ 阅读我们的 文档。您还可以查看我们的 5 分钟快速入门教程 <https://deepinv.github.io/deepinv/auto_examples/basics/demo_quickstart.html>、全面示例 <https://deepinv.github.io/deepinv/auto_examples/index.html> 或者 用户指南 <https://deepinv.github.io/deepinv/user_guide.html>_。

deepinv 的主要特性包括：

• 一个庞大的 预定义成像算子框架 <https://deepinv.github.io/deepinv/user_guide/physics/physics.html>_
• 许多 最先进的深度神经网络 <https://deepinv.github.io/deepinv/user_guide/reconstruction/introduction.html>，包括开箱即用的预训练 重建模型 <https://deepinv.github.io/deepinv/user_guide/reconstruction/pretrained-models.html> 和 去噪器 <https://deepinv.github.io/deepinv/user_guide/reconstruction/denoisers.html>_
• 用于 即插即用复原 <https://deepinv.github.io/deepinv/user_guide/reconstruction/iterative.html>、优化 <https://deepinv.github.io/deepinv/user_guide/reconstruction/optimization.html> 和 展开架构 <https://deepinv.github.io/deepinv/user_guide/reconstruction/unfolded.html>_ 的综合框架
• 用于逆问题的 训练损失函数 <https://deepinv.github.io/deepinv/user_guide/training/loss.html>_
• 用于不确定性量化的一系列 采样算法和扩散模型 <https://deepinv.github.io/deepinv/user_guide/reconstruction/sampling.html>_
• 一个用于为逆问题 构建数据集 <https://deepinv.github.io/deepinv/user_guide/training/datasets.html>_ 的框架

邮件列表

`加入我们的邮件列表 <https://forms.gle/TFyT7M2HAWkJYfvQ7>`_，以获取有关发布和新功能的定期更新。

安装
-----

使用 Python 3.10 或更高版本安装 ``deepinv`` 的最新稳定版
（请参阅 `文档 <https://deepinv.github.io/deepinv/#install>`_ 中关于使用 `uv`、`pixi` 和 `conda` 进行安装的内容）：

.. code-block:: bash

   pip install deepinv

或者，如果您还想安装可选依赖项：

.. code-block:: bash

   pip install deepinv[dataset,denoisers]

由于 ``deepinv`` 处于积极开发中，您也可以通过以下命令安装最新的夜间版本：

.. code-block:: bash

   pip install git+https://github.com/deepinv/deepinv.git#egg=deepinv

或者，如果您需要更新现有安装：

.. code-block:: bash

   pip install --upgrade --force-reinstall --no-deps git+https://github.com/deepinv/deepinv.git#egg=deepinv


寻求帮助
--------

如果您有任何问题或建议，请加入我们的
`Discord 服务器 <https://discord.gg/qBqY5jKw3p>`_ 进行交流。对于任何错误或问题，我们推荐您通过
`提交 issue <https://github.com/deepinv/deepinv/issues>`_ 来联系开发者。

维护者
~~~~~~~

请与我们的 `维护者 <https://github.com/deepinv/deepinv/blob/main/MAINTAINERS.md>`_ 联系。


贡献
----

DeepInverse 是一个 `社区驱动的项目 <https://deepinv.github.io/deepinv/community.html>`_，我们鼓励各种形式的贡献。我们正在构建一个全面的逆问题与深度学习库，而实现这一目标离不开您的帮助！ 

感兴趣吗？`查看如何参与贡献 <https://deepinv.github.io/deepinv/contributing.html>`_！

引用
----
如果您在研究中使用了 DeepInverse，请引用我们在 JOSS 上发表的论文：

.. code-block:: bash

    @article{tachella2025deepinverse,
        title = {DeepInverse: A Python package for solving imaging inverse problems with deep learning},
        journal = {Journal of Open Source Software},
        doi = {10.21105/joss.08923},
        url = {https://doi.org/10.21105/joss.08923},
        year = {2025},
        publisher = {The Open Journal},
        volume = {10},
        number = {115},
        pages = {8923},
        author = {Tachella, Julián and Terris, Matthieu and Hurault, Samuel and Wang, Andrew and Davy, Leo and Scanvic, Jérémy and Sechaud, Victor and Vo, Romain and Moreau, Thomas and Davies, Thomas and Chen, Dongdong and Laurent, Nils and Monroy, Brayan and Dong, Jonathan and Hu, Zhiyuan and Nguyen, Minh-Hai and Sarron, Florian and Weiss, Pierre and Escande, Paul and Massias, Mathurin and Modrzyk, Thibaut and Levac, Brett and Liaudat, Tobías I. and Song, Maxime and Hertrich, Johannes and Neumayer, Sebastian and Schramm, Georg},
    }

星标历史
--------

.. image:: https://api.star-history.com/svg?repos=deepinv/deepinv&type=Date
   :alt: 星标历史图表
   :target: https://www.star-history.com/#deepinv/deepinv&Date

.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
.. |测试状态| image:: https://github.com/deepinv/deepinv/actions/workflows/test_cpu.yml/badge.svg?branch=main&event=push
   :target: https://github.com/deepinv/deepinv/actions/workflows/test_cpu.yml
.. |GPU测试状态| image:: https://github.com/deepinv/deepinv/actions/workflows/test_gpu.yml/badge.svg?branch=main&event=push
   :target: https://github.com/deepinv/deepinv/actions/workflows/test_gpu.yml
.. |文档状态| image:: https://github.com/deepinv/deepinv/actions/workflows/docs_cpu.yml/badge.svg
   :target: https://github.com/deepinv/deepinv/actions/workflows/docs_cpu.yml
.. |GPU文档状态| image:: https://github.com/deepinv/deepinv/actions/workflows/docs_gpu.yml/badge.svg?branch=main&event=push
   :target: https://github.com/deepinv/deepinv/actions/workflows/docs_gpu.yml
.. |Python版本| image:: https://img.shields.io/badge/python-3.10%2B-blue
   :target: https://www.python.org/downloads/release/python-3100/
.. |codecov| image:: https://codecov.io/gh/deepinv/deepinv/branch/main/graph/badge.svg?token=77JRvUhQzh
   :target: https://codecov.io/gh/deepinv/deepinv
.. |pip安装| image:: https://img.shields.io/pypi/dm/deepinv.svg?logo=pypi&label=pip%20install&color=fedcba
   :target: https://pypistats.org/packages/deepinv
.. |discord| image:: https://dcbadge.limes.pink/api/server/qBqY5jKw3p?style=flat
   :target: https://discord.gg/qBqY5jKw3p
.. |colab| image:: https://colab.research.google.com/assets/colab-badge.svg
   :target: https://colab.research.google.com/github/deepinv/deepinv/blob/gh-pages/auto_examples/_notebooks/basics/demo_quickstart.ipynb
.. |youtube| image:: https://img.shields.io/badge/YouTube-deepinv-red?logo=youtube
   :target: https://www.youtube.com/@deepinv
.. |论文| image:: https://joss.theoj.org/papers/10.21105/joss.08923/status.svg
   :target: https://doi.org/10.21105/joss.08923
.. |星标| image:: https://img.shields.io/github/stars/deepinv/deepinv?style=flat&label=%E2%AD%90%20Star%20us%20on%20GitHub
   :target: https://github.com/deepinv/deepinv

DeepInverse 快速上手指南

DeepInverse 是一个基于 PyTorch 的开源库，专为利用深度学习解决成像逆问题（如去噪、超分辨率、CT 重建等）而设计。它提供了丰富的预定义成像算子、前沿的重建网络以及即插即用的恢复框架。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows
• Python 版本：3.10 或更高版本
• 核心依赖：PyTorch (建议安装与您的 CUDA 版本匹配的 PyTorch)
• 可选加速：推荐使用国内镜像源（如清华源或阿里源）以加快依赖下载速度。

安装步骤

1. 基础安装

使用 pip 安装最新稳定版。若需加速下载，可添加 -i 参数指定国内源：

pip install deepinv -i https://pypi.tuna.tsinghua.edu.cn/simple

2. 安装可选依赖

如果您需要使用内置的数据集加载器或预训练去噪器，建议安装完整功能包：

pip install "deepinv[dataset,denoisers]" -i https://pypi.tuna.tsinghua.edu.cn/simple

3. 安装开发版（可选）

如需体验最新功能（夜间构建版），可从 GitHub 直接安装：

pip install git+https://github.com/deepinv/deepinv.git#egg=deepinv -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

以下是一个最简单的示例，演示如何加载一个预训练的去噪模型并对含噪图像进行重建。

import torch
import deepinv as dinv
from deepinv.utils.demo import load_url_image

# 1. 加载一张示例图像并添加高斯噪声
url = "https://huggingface.co/datasets/deepinv/images/resolve/main/cameraman.png"
x = load_url_image(url, img_size=256, device="cpu")
noise_model = dinv.physics.GaussianNoise(sigma=0.1)
y = noise_model(x)

# 2. 加载预训练的去噪模型 (例如 DRUNet)
model = dinv.models.DRUNet(pretrained="download")

# 3. 执行重建
with torch.no_grad():
    x_recon = model(y, sigma=0.1)

# 4. 计算重建误差 (PSNR)
psnr = dinv.metrics.psnr(x, x_recon)
print(f"Reconstruction PSNR: {psnr:.2f} dB")

下一步建议：

• 访问 官方文档 查看详细的用户指南。
• 运行 5 分钟快速入门教程 了解更多高级用法。
• 加入 Discord 社区 获取帮助和交流。