Getting started

=========================

Welcome to `medigan`: **medi**\ cal  **g**\ enerative (\ **a**\ dversarial) **n**\ etworks

Let's install `medigan` and generate a few synthetic images.

.. code-block:: Python

    pip install medigan

.. code-block:: Python

    from medigan import Generators

    # model 1 is "00001_DCGAN_MMG_CALC_ROI"

    Generators().generate(model_id=1, install_dependencies=True)

Overview

===================

.. figure:: _static/overview.png

   :alt: Overview

   Overview of `medigan` users, library, and models on the example of mammography cancer image dataset generation.

.. note::

    Check out our `article <https://arxiv.org/abs/2209.14472>`_ on `medigan` to get all the details.

.. toctree::

   :caption: Description

   :maxdepth: 3

   description

.. toctree::

   :caption: Models

   :maxdepth: 3

   models

.. toctree::

   :caption: Getting Started

   :maxdepth: 3

   code_examples

.. toctree::

   :caption: API Reference

   :maxdepth: 2

   modules_overview

   code_doc

.. toctree::

   :caption: Tests

   :maxdepth: 5

   tests

.. toctree::

   :caption: Add Your Model

   :maxdepth: 3

   adding_models

Indices

=======

* :ref:`genindex`

* :ref:`modindex`

* :ref:`search`