.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "usage_examples/flow/plot_dark_background.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_usage_examples_flow_plot_dark_background.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_usage_examples_flow_plot_dark_background.py:

Dark Background
=======================================

``background_fill`` isn't limited to plain white - it also accepts a transparent color
(e.g. ``(0, 0, 0, 0)``), useful for dropping a figure onto a paper/slide without a white box
around it, or an opaque dark color for a nicer look on dark-mode pages.

Note: when using a non-white background, also set an ``outline`` per layer type in
``color_map``. Box borders and funnel connector lines default to plain black, which becomes
invisible against a dark or black background.

.. GENERATED FROM PYTHON SOURCE LINES 12-52



.. image-sg:: /usage_examples/flow/images/sphx_glr_plot_dark_background_001.png
   :alt: plot dark background
   :srcset: /usage_examples/flow/images/sphx_glr_plot_dark_background_001.png
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    /home/docs/checkouts/readthedocs.org/user_builds/visualtorch/checkouts/v1.1.0/docs/examples/flow/plot_dark_background.py:50: UserWarning: Tight layout not applied. The bottom and top margins cannot be made large enough to accommodate all Axes decorations.
      plt.tight_layout()






|

.. code-block:: Python


    from collections import defaultdict

    import matplotlib.pyplot as plt
    import visualtorch
    from torch import nn

    # Example of a simple CNN model using nn.Sequential
    model = nn.Sequential(
        nn.Conv2d(3, 16, kernel_size=3, padding=1),
        nn.BatchNorm2d(16),
        nn.ReLU(),
        nn.Conv2d(16, 32, kernel_size=3, padding=1),
        nn.BatchNorm2d(32),
        nn.ReLU(),
    )

    color_map: dict = defaultdict(dict)
    color_map[nn.Conv2d]["fill"] = "#00F5FF"
    color_map[nn.Conv2d]["outline"] = "#E0FFFF"
    color_map[nn.BatchNorm2d]["fill"] = "#FF10F0"
    color_map[nn.BatchNorm2d]["outline"] = "#FFD1FA"
    color_map[nn.ReLU]["fill"] = "#FCEE09"
    color_map[nn.ReLU]["outline"] = "#FFFACD"

    input_shape = (1, 3, 32, 32)
    img = visualtorch.render(
        model,
        input_shape=input_shape,
        style="flow",
        color_map=color_map,
        background_fill="black",
    )

    dpi = 150  # rendered at 2x this in the final doc build (savefig.dpi=300 in conf.py)
    plt.figure(figsize=(img.width / dpi, img.height / dpi), dpi=dpi)
    plt.imshow(img)
    plt.axis("off")
    plt.tight_layout()
    plt.show()


.. _sphx_glr_download_usage_examples_flow_plot_dark_background.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_dark_background.ipynb <plot_dark_background.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_dark_background.py <plot_dark_background.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_dark_background.zip <plot_dark_background.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_