Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mcencini committed Jan 10, 2024
1 parent f453835 commit f096d9f
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 5 deletions.
15 changes: 15 additions & 0 deletions docs/source/api/prox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Iterative Optimization (`deepmr.optim`)

```{eval-rst}
.. automodule:: deepmr.optim
```
## First-order Gradient Methods
```{eval-rst}
.. autosummary::
:toctree: generated
:nosignatures:
deepmr.prox.wavelet
```

## Other Methods
1 change: 1 addition & 0 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ tutorials/02-dl-mri-recon.ipynb
api/io.md
api/optim.md
api/prox.md
```

Expand Down
2 changes: 2 additions & 0 deletions src/deepmr/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@

from . import io
from . import optim
from . import prox

from .testdata import testdata
2 changes: 1 addition & 1 deletion src/deepmr/io/image/dicom.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
from ..utils import dicom
from ..utils.header import Header

def read_dicom(filepath: str | list | tuple):
def read_dicom(filepath):# str | list | tuple):
"""
Read image from dicom files.
Expand Down
2 changes: 1 addition & 1 deletion src/deepmr/io/image/nifti.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
from ..utils.header import Header


def read_nifti(filepath: str | list | tuple):
def read_nifti(filepath):# str | list | tuple):
"""
Read image from nifti files.
Expand Down
9 changes: 6 additions & 3 deletions src/deepmr/prox/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,16 @@
"""

from deepinv.models import BM3D, TV, TGV

from . import llr as _llr
from . import wavelet as _wavelet

from .llr import * # noqa
from .wavelet import * # noqa

__all__ = []
__all__.extend(_admm.__all__)
__all__.extend(_pgd.__all__)
__all__ = ["BM3D", "TV", "TGV"]

# __all__.extend(_llr.__all__)
__all__.extend(_wavelet.__all__)

0 comments on commit f096d9f

Please sign in to comment.