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

.. only:: html

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

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

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

.. _sphx_glr_tutorials_basic_usages_02_model_definition_by_yaml_file.py:


.. _second:


Model Definition by Yaml file
----------------------------------------------------

Phlower offers a way to define models and its order by yaml file.

.. GENERATED FROM PYTHON SOURCE LINES 14-19

First of all, we would like to load sample yaml data. Please download sample sample yaml.
`data.yml
<https://github.com/ricosjp/phlower/tutorials/basic_usages/sample_data/model/model.yml>`_

we construct PhlowerSetting object from yaml file.

.. GENERATED FROM PYTHON SOURCE LINES 19-25

.. code-block:: Python


    from phlower.settings import PhlowerSetting

    setting = PhlowerSetting.read_yaml("sample_data/model/model.yml")









.. GENERATED FROM PYTHON SOURCE LINES 26-28

Order of models must be DAG (Directed Acyclic Graph).
To check such conditions, we call `resolve` function.

.. GENERATED FROM PYTHON SOURCE LINES 28-32

.. code-block:: Python


    setting.model.network.resolve(is_first=True)









.. GENERATED FROM PYTHON SOURCE LINES 33-37

In phlower, networks are packed into PhlowerGroupModule.
PhlowerGroupModule is directly created from model setting.

`draw` function generate a file following to mermaid format.

.. GENERATED FROM PYTHON SOURCE LINES 37-44

.. code-block:: Python


    from phlower.nn import PhlowerGroupModule

    model = PhlowerGroupModule.from_setting(setting.model.network)
    model.draw("images")









.. GENERATED FROM PYTHON SOURCE LINES 45-51

The output mermaid file is shown below.

.. mermaid:: ../../tutorials/basic_usages/images/SAMPLE_MODEL.mmd

According to this image, we can understand details of each model and data flow.



.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.009 seconds)


.. _sphx_glr_download_tutorials_basic_usages_02_model_definition_by_yaml_file.py:

.. only:: html

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

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

      :download:`Download Jupyter notebook: 02_model_definition_by_yaml_file.ipynb <02_model_definition_by_yaml_file.ipynb>`

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

      :download:`Download Python source code: 02_model_definition_by_yaml_file.py <02_model_definition_by_yaml_file.py>`

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

      :download:`Download zipped: 02_model_definition_by_yaml_file.zip <02_model_definition_by_yaml_file.zip>`


.. only:: html

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

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