deepinv.utils
=============

This module provides various plotting and utility functions.
Please refer to the :ref:`user guide <utils>` for more information.

Plotting
--------
.. userguide:: plotting

.. autosummary::
   :toctree: stubs
   :template: myfunc_template.rst
   :nosignatures:

        deepinv.utils.plot
        deepinv.utils.plot_curves
        deepinv.utils.plot_parameters
        deepinv.utils.plot_inset
        deepinv.utils.plot_videos
        deepinv.utils.plot_ortho3D


TensorList
----------
.. userguide:: tensorlist

.. autosummary::
   :toctree: stubs
   :template: myclass_template.rst
   :nosignatures:

        deepinv.utils.TensorList
        deepinv.utils.zeros_like
        deepinv.utils.ones_like
        deepinv.utils.randn_like
        deepinv.utils.rand_like


Other
-----
.. userguide:: other-utils

.. autosummary::
   :toctree: stubs
   :template: myfunc_template.rst
   :nosignatures:

        deepinv.utils.get_freer_gpu
        deepinv.utils.load_url_image
        deepinv.utils.get_data_home
        deepinv.utils.load_image
        deepinv.utils.demo.demo_mri_model