======
Models
======

Model objects are used for composing models that are fitted to data.

It is recommended the `model API cookbooks <https://pyautofit.readthedocs.io/en/latest/cookbooks/model.html>`_ are used for guidance on building complex model.

**Examples / Tutorials:**

- `Model API Cookbooks (recommended) <https://pyautofit.readthedocs.io/en/latest/cookbooks/model.html>`_.

- `readthedocs: example using Model object <https://pyautofit.readthedocs.io/en/latest/overview/the_basics.html>`_.
- `readthedocs: example using Collection object <https://pyautofit.readthedocs.io/en/latest/cookbooks/model.html>`_.
- `autofit_workspace: simple tutorial <https://github.com/PyAutoLabs/autofit_workspace/blob/main/notebooks/overview/overview_1_the_basics.ipynb>`_
- `autofit_workspace: complex tutorial <https://github.com/PyAutoLabs/autofit_workspace/blob/main/notebooks/overview/overview_2_scientific_workflow.ipynb>`_
- `HowToFit: tutorial lectures (detailed step-by-step examples) <https://github.com/PyAutoLabs/HowToFit>`_

------
Models
------

.. currentmodule:: autofit

.. autosummary::
   :toctree: _autosummary
   :template: custom-class-template.rst
   :recursive:

   Model
   Collection