.. _api.emulator:

===========
Emulator
===========

.. currentmodule:: twinlab

The following functions are contained in the ``twinlab.Emulator`` class.

Constructor
~~~~~~~~~~~
.. autosummary::
   :toctree: api/

   Emulator

Setting up
~~~~~~~~~~

.. autosummary::
   :toctree: api/

   Emulator.design

Train
~~~~~

.. autosummary::
   :toctree: api/

   Emulator.train
   Emulator.status
   Emulator.view
   Emulator.view_train_data
   Emulator.view_test_data

Explore
~~~~~~~

.. autosummary::
   :toctree: api/

   Emulator.summarise 
   Emulator.score
   Emulator.benchmark
   Emulator.list_processes
   Emulator.list_processes_statuses
   Emulator.get_process

Predict
~~~~~~~

.. autosummary::
   :toctree: api/

   Emulator.predict
   Emulator.sample

Plot
~~~~

.. autosummary::
   :toctree: api/

   Emulator.plot
   Emulator.heatmap

Improve
~~~~~~~

.. autosummary::
   :toctree: api/

   Emulator.update
   Emulator.recommend
   Emulator.learn
   Emulator.calibrate
   Emulator.maximize

Delete
~~~~~~

.. autosummary::
   :toctree: api/

   Emulator.delete

Export
~~~~~~

.. autosummary::
   :toctree: api/

   Emulator.export

FMU
~~~~~~

.. autosummary::
   :toctree: api/

   Emulator.fmu


Lock
~~~~

.. autosummary::
   :toctree: api/

   Emulator.lock
   Emulator.unlock