Skip to main content
TFMRI logo

pypi build docs doi

TensorFlow MRI is a library of TensorFlow operators for computational MRI. The library has a Python interface and is mostly written in Python. However, computations are efficiently performed by the TensorFlow backend (implemented in C++/CUDA), which brings together the ease of use and fast prototyping of Python with the speed and efficiency of optimized lower-level implementations.

Being an extension of TensorFlow, TensorFlow MRI integrates seamlessly in ML applications. No additional interfacing is needed to include a SENSE operator within a neural network, or to use a trained prior as part of an iterative reconstruction. Therefore, the gap between ML and non-ML components of image processing pipelines is eliminated.

Whether an application involves ML or not, TensorFlow MRI operators can take full advantage of the TensorFlow framework, with capabilities including automatic differentiation, multi-device support (CPUs and GPUs), automatic device placement and copying of tensor data, and conversion to fast, serializable graphs.

TensorFlow MRI contains operators for:

  • Multicoil arrays (tfmri.coils): coil combination, coil compression and estimation of coil sensitivity maps.

  • Convex optimization (tfmri.convex): convex functions (quadratic, L1, L2, Tikhonov, total variation, etc.) and optimizers (ADMM).

  • Keras initializers (tfmri.initializers): neural network initializers, including support for complex-valued weights.

  • I/O (tfmri.io): additional I/O functions potentially useful when working with MRI data.

  • Keras layers (tfmri.layers): layers and building blocks for neural networks, including support for complex-valued weights, inputs and outputs.

  • Linear algebra (tfmri.linalg): linear operators specialized for image processing and MRI.

  • Loss functions (tfmri.losses): for classification, segmentation and image restoration.

  • Metrics (tfmri.metrics): for classification, segmentation and image restoration.

  • Image processing (tfmri.image): filtering, gradients, phantoms, image quality assessment, etc.

  • Image reconstruction (tfmri.recon): Cartesian/non-Cartesian, 2D/3D, parallel imaging, compressed sensing.

  • k-space sampling (tfmri.sampling): Cartesian masks, non-Cartesian trajectories, sampling density compensation, etc.

  • Signal processing (tfmri.signal): N-dimensional fast Fourier transform (FFT), non-uniform FFT (NUFFT) (see also TensorFlow NUFFT), discrete wavelet transform (DWT), k-space filtering, etc.

  • Unconstrained optimization (tfmri.optimize): gradient descent, L-BFGS.

  • And more, e.g., supporting array manipulation and math tasks.

Installation

You can install TensorFlow MRI with pip:

$ pip install tensorflow-mri

Note that only Linux is currently supported.

TensorFlow Compatibility

Each TensorFlow MRI release is compiled against a specific version of TensorFlow. To ensure compatibility, it is recommended to install matching versions of TensorFlow and TensorFlow MRI according to the table below.

TensorFlow MRI Version

TensorFlow Compatibility

Release Date

v0.22.0

v2.10.x

Sep 26, 2022

v0.21.0

v2.9.x

Jul 24, 2022

v0.20.0

v2.9.x

Jun 18, 2022

v0.19.0

v2.9.x

Jun 1, 2022

v0.18.0

v2.8.x

May 6, 2022

v0.17.0

v2.8.x

Apr 22, 2022

v0.16.0

v2.8.x

Apr 13, 2022

v0.15.0

v2.8.x

Apr 1, 2022

v0.14.0

v2.8.x

Mar 29, 2022

v0.13.0

v2.8.x

Mar 15, 2022

v0.12.0

v2.8.x

Mar 14, 2022

v0.11.0

v2.8.x

Mar 10, 2022

v0.10.0

v2.8.x

Mar 3, 2022

v0.9.0

v2.7.x

Dec 3, 2021

v0.8.0

v2.7.x

Nov 11, 2021

v0.7.0

v2.6.x

Nov 3, 2021

v0.6.2

v2.6.x

Oct 13, 2021

v0.6.1

v2.6.x

Sep 30, 2021

v0.6.0

v2.6.x

Sep 28, 2021

v0.5.0

v2.6.x

Aug 29, 2021

v0.4.0

v2.6.x

Aug 18, 2021

Documentation

Visit the docs for guides, tutorials and the API reference.

Issues

If you use this package and something does not work as you expected, please file an issue describing your problem. We’re here to help!

Credits

If you like this software, star the repository! stars

If you find this software useful in your research, you can cite TensorFlow MRI using its Zenodo record.

In the above link, scroll down to the “Export” section and select your favorite export format to get an up-to-date citation.

Contributions

Contributions of any kind are welcome! Open an issue or pull request to begin.

Metadata

Release files for tensorflow-mri 0.22.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for tensorflow-mri 0.22.0
File
tensorflow_mri-0.22.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.10 CPython 3.10 Linux glibc 2.17+ x86-64 Details
tensorflow_mri-0.22.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.9 CPython 3.9 Linux glibc 2.17+ x86-64 Details
tensorflow_mri-0.22.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.8 CPython 3.8 Linux glibc 2.17+ x86-64 Details
tensorflow_mri-0.22.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.17+ x86-64 Details

Total release size: 1.1 MB

Release files / tensorflow_mri-0.22.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL tensorflow_mri-0.22.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 265.3 kB
Tags CPython 3.10 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
63b4c023b8f8c13ef2fe46295b09dbb088bbe1a95499c4049cfddea4ca95c260
BLAKE2b-256 checksum
How to use checksums
a475fc496c34f6f4b6c3cc8743a0a0721e102b1383115ecf6850100dc30f930e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.14

Release files / tensorflow_mri-0.22.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL tensorflow_mri-0.22.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 265.3 kB
Tags CPython 3.9 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
ac877eb9d061c5ac9763daa10b15d7a0d3f733662e7287100200c5674e59c78b
BLAKE2b-256 checksum
How to use checksums
12b9498bbb9ef281ed30ff76467419b8f97973b02a88e2fcd4f4a807780a4fa6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.14

Release files / tensorflow_mri-0.22.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL tensorflow_mri-0.22.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 265.3 kB
Tags CPython 3.8 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
347be36ce61a8cc2b36a9646f30ca63119cceb65f4252bdc08a3685679d26793
BLAKE2b-256 checksum
How to use checksums
e23356f296dc46f7cc893573239d38d13d5e6bc54154116e7d1facf1305d49a8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.14

Release files / tensorflow_mri-0.22.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL tensorflow_mri-0.22.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 265.3 kB
Tags CPython 3.7 CPython 3.7 pymalloc Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
d89a60f7ceffc0d092456f93ae37755b22bb707f3a8fd1595bb48aaa2b5c4d3c
BLAKE2b-256 checksum
How to use checksums
5138b6b83ddcbdd9a92b96f44896d0153e07be73e5103996f94c81e05bc61bad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.14

Security for tensorflow-mri 0.22.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.22.0 This release

4 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page