deepinv 0.3.2__tar.gz → 0.3.3__tar.gz

{deepinv-0.3.2 → deepinv-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deepinv
-Version: 0.3.2
+Version: 0.3.3
 Summary: DeepInverse: a PyTorch library for imaging with deep learning
 Author: DeepInverse maintainers (see https://github.com/deepinv/deepinv/blob/main/MAINTAINERS.md)
 License: BSD 3-Clause
@@ -14,23 +14,25 @@ Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Utilities
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: numpy
 Requires-Dist: matplotlib
-Requires-Dist: hdf5storage
 Requires-Dist: tqdm
-Requires-Dist: torch<2.7
+Requires-Dist: torch>=2.2.0
 Requires-Dist: torchvision
 Requires-Dist: torchmetrics
 Requires-Dist: einops
-Requires-Dist: wandb
 Requires-Dist: scipy
-Requires-Dist: natsort
+Requires-Dist: requests
+Requires-Dist: h5py
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
@@ -45,6 +47,10 @@ Requires-Dist: sphinx_copybutton; extra == "doc"
 Requires-Dist: sphinx_autoapi; extra == "doc"
 Requires-Dist: sphinx-design; extra == "doc"
 Requires-Dist: sphinx_sitemap<2.7.0; extra == "doc"
+Requires-Dist: sphinxcontrib.bibtex; extra == "doc"
+Provides-Extra: lint
+Requires-Dist: black; extra == "lint"
+Requires-Dist: ruff; extra == "lint"
 Provides-Extra: denoisers
 Requires-Dist: bm3d; extra == "denoisers"
 Requires-Dist: bm4d<4.2.4; extra == "denoisers"
@@ -63,6 +69,9 @@ Requires-Dist: datasets; extra == "dataset"
 Requires-Dist: pandas; extra == "dataset"
 Requires-Dist: pydicom; extra == "dataset"
 Requires-Dist: mat73; extra == "dataset"
+Requires-Dist: natsort; extra == "dataset"
+Provides-Extra: training
+Requires-Dist: wandb; extra == "training"
 Dynamic: license-file
 
 .. image:: https://github.com/deepinv/deepinv/raw/main/docs/source/figures/deepinv_logolarge.png
@@ -109,6 +118,10 @@ To install the latest stable release of ``deepinv``, you can simply do:
 
     pip install deepinv
 
+    # or using uv for faster installation
+
+    uv pip install deepinv
+
 You can also install the latest version of ``deepinv`` directly from github:
 
 .. code-block:: bash
@@ -215,8 +228,8 @@ Star history
    :target: https://github.com/deepinv/deepinv/actions/workflows/test.yml
 .. |Docs Status| image:: https://github.com/deepinv/deepinv/actions/workflows/documentation.yml/badge.svg
    :target: https://github.com/deepinv/deepinv/actions/workflows/documentation.yml
-.. |Python Version| image:: https://img.shields.io/badge/python-3.9%2B-blue
-   :target: https://www.python.org/downloads/release/python-390/
+.. |Python Version| 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 install| image:: https://img.shields.io/pypi/dm/deepinv.svg?logo=pypi&label=pip%20install&color=fedcba

{deepinv-0.3.2 → deepinv-0.3.3}/README.rst

@@ -42,6 +42,10 @@ To install the latest stable release of ``deepinv``, you can simply do:
 
     pip install deepinv
 
+    # or using uv for faster installation
+
+    uv pip install deepinv
+
 You can also install the latest version of ``deepinv`` directly from github:
 
 .. code-block:: bash
@@ -148,8 +152,8 @@ Star history
    :target: https://github.com/deepinv/deepinv/actions/workflows/test.yml
 .. |Docs Status| image:: https://github.com/deepinv/deepinv/actions/workflows/documentation.yml/badge.svg
    :target: https://github.com/deepinv/deepinv/actions/workflows/documentation.yml
-.. |Python Version| image:: https://img.shields.io/badge/python-3.9%2B-blue
-   :target: https://www.python.org/downloads/release/python-390/
+.. |Python Version| 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 install| image:: https://img.shields.io/pypi/dm/deepinv.svg?logo=pypi&label=pip%20install&color=fedcba

{deepinv-0.3.2 → deepinv-0.3.3}/deepinv/__about__.py

@@ -7,3 +7,12 @@ __version__ = metadata["Version"]
 __author__ = metadata["Author"]
 __license__ = metadata["License"]
 __url__ = metadata["Project-URL"]
+
+__all__ = [
+    "__title__",
+    "__summary__",
+    "__version__",
+    "__author__",
+    "__license__",
+    "__url__",
+]

{deepinv-0.3.2 → deepinv-0.3.3}/deepinv/datasets/__init__.py

@@ -17,3 +17,4 @@ from .fmd import FMD
 from .kohler import Kohler
 from .utils import download_archive
 from .satellite import NBUDataset
+from .skmtea import SKMTEASliceDataset

{deepinv-0.3.2 → deepinv-0.3.3}/deepinv/datasets/cbsd68.py

@@ -8,16 +8,16 @@ from deepinv.datasets.utils import calculate_md5
 error_import = None
 try:
     from datasets import load_dataset as load_dataset_hf, load_from_disk
-except:
+except ImportError:  # pragma: no cover
     error_import = ImportError(
         "datasets is not available. Please install the datasets package with `pip install datasets`."
-    )
+    )  # pragma: no cover
 
 
 class CBSD68(torch.utils.data.Dataset):
     """Dataset for `CBSBD68 <https://paperswithcode.com/dataset/cbsd68>`_.
 
-    Color BSD68 dataset for image restoration benchmarks is part of The Berkeley Segmentation Dataset and Benchmark.
+    Color BSD68 dataset for image restoration benchmarks is part of The Berkeley Segmentation Dataset and Benchmark from :footcite:t:`martin2001database`.
     It is used for measuring image restoration algorithms performance. It contains 68 images.
 
 

{deepinv-0.3.2 → deepinv-0.3.3}/deepinv/datasets/cmrxrecon.py

@@ -1,7 +1,14 @@
 from typing import Any, Callable, Optional, Union
 from pathlib import Path
 import os
-from natsort import natsorted
+
+try:
+    from natsort import natsorted
+except ImportError:  # pragma: no cover
+    natsorted = ImportError(
+        "natsort is not available. In order to use CMRxReconSliceDataset, please install the natsort package with `pip install natsort`."
+    )  # pragma: no cover
+
 from tqdm import tqdm
 from warnings import warn
 
@@ -145,6 +152,9 @@ class CMRxReconSliceDataset(FastMRISliceDataset, MRIMixin):
                 f"Data or mask folder does not exist. Please set root, data_dir and mask_dir properly."
             )
 
+        if isinstance(natsorted, ImportError):
+            raise natsorted
+
         all_fnames = natsorted(
             f
             for f in (self.root / self.data_dir).rglob("**/*.mat")
@@ -210,7 +220,7 @@ class CMRxReconSliceDataset(FastMRISliceDataset, MRIMixin):
         kspace = kspace.moveaxis(-1, 1)  # shape CTWH
         target = None
 
-        # The following is akin to :class:`deepinv.datasets.fastmri.MRISliceTransform` and will be moved
+        # TODO The following is akin to :class:`deepinv.datasets.fastmri.MRISliceTransform` and will be moved
         # to a separate CMRxReconTransform in future.
 
         # Load mask
@@ -260,6 +270,6 @@ class CMRxReconSliceDataset(FastMRISliceDataset, MRIMixin):
 
         if self.apply_mask:
             kspace = kspace * mask + 0.0
-            return target, kspace, {"mask": mask.float()}
+            return target, kspace.float(), {"mask": mask.float()}
         else:
-            return target, kspace
+            return target, kspace.float()

{deepinv-0.3.2 → deepinv-0.3.3}/deepinv/datasets/datagenerator.py

@@ -4,7 +4,13 @@ from typing import TYPE_CHECKING, Union, Callable
 from tqdm import tqdm
 import os
 from warnings import warn
-import h5py
+
+try:
+    import h5py
+except ImportError:  # pragma: no cover
+    h5py = ImportError(
+        "The h5py package is not installed. Please install it with `pip install h5py`."
+    )  # pragma: no cover
 import torch
 
 from torch import Tensor
@@ -60,6 +66,9 @@ class HDF5Dataset(data.Dataset):
         self.load_physics_generator_params = load_physics_generator_params
         self.cast = lambda x: x.type(complex_dtype if x.is_complex() else dtype)
 
+        if isinstance(h5py, ImportError):
+            raise h5py
+
         hd5 = h5py.File(path, "r")
         suffix = ("_train" if train else "_test") if split is None else f"_{split}"
 
@@ -203,6 +212,9 @@ def generate_dataset(
     :param torch.device, str device: device, e.g. cpu or gpu, on which to generate measurements. All data is moved back to cpu before saving.
 
     """
+    if isinstance(h5py, ImportError):
+        raise h5py
+
     if test_dataset is None and train_dataset is None and val_dataset is None:
         raise ValueError("No train or test datasets provided.")
 

{deepinv-0.3.2 → deepinv-0.3.3}/deepinv/datasets/div2k.py

@@ -14,8 +14,9 @@ from deepinv.datasets.utils import (
 class DIV2K(torch.utils.data.Dataset):
     """Dataset for `DIV2K Image Super-Resolution Challenge <https://data.vision.ee.ethz.ch/cvl/DIV2K>`_.
 
-    Images have varying sizes with up to 2040 vertical pixels, and 2040 horizontal pixels.
+    The DIV2K dataset from :footcite:t:`agustsson2017ntire` is a high-quality image dataset originally built for image super-resolution tasks.
 
+    Images have varying sizes with up to 2040 vertical pixels, and 2040 horizontal pixels.
 
     **Raw data file structure:** ::
 
@@ -51,6 +52,8 @@ class DIV2K(torch.utils.data.Dataset):
         >>> print(len(dataset))                                            # check that we have 100 images
         100
         >>> shutil.rmtree("DIV2K")                                    # remove raw data from disk
+
+
     """
 
     # https://data.vision.ee.ethz.ch/cvl/DIV2K/