.. _model:

.. currentmodule:: parametricmatrixmodels

=========
``Model``
=========

Basic Usage
-----------

TODO

Advanced Usage
--------------

TODO

Saving and Loading Models
-------------------------

TODO

API Reference
-------------

.. autoclass:: Model
   :show-inheritance:
   :exclude-members: __repr__, __init__, get_num_trainable_floats, reset, append_module, prepend_module, insert_module, add, put, insert, remove_module, pop_module, __getitem__, compile, get_output_shape, get_params, set_params, get_state, set_state, get_rng, set_rng, _get_callable, __call__, predict, set_precision, astype, train, serialize, deserialize, save, save_compressed, load, from_file

.. autosummary::
   :nosignatures:

    ~Model.__init__
    ~Model.get_num_trainable_floats
    ~Model.reset
    ~Model.append_module
    ~Model.prepend_module
    ~Model.insert_module
    ~Model.add
    ~Model.put
    ~Model.insert
    ~Model.remove_module
    ~Model.pop_module
    ~Model.__getitem__
    ~Model.compile
    ~Model.get_output_shape
    ~Model.get_params
    ~Model.set_params
    ~Model.get_state
    ~Model.set_state
    ~Model.get_rng
    ~Model.set_rng
    ~Model._get_callable
    ~Model.__call__
    ~Model.predict
    ~Model.set_precision
    ~Model.astype
    ~Model.train
    ~Model.serialize
    ~Model.deserialize
    ~Model.save
    ~Model.save_compressed
    ~Model.load
    ~Model.from_file

.. automethod:: Model.__init__
.. automethod:: Model.get_num_trainable_floats
.. automethod:: Model.reset
.. automethod:: Model.append_module
.. automethod:: Model.prepend_module
.. automethod:: Model.insert_module
.. automethod:: Model.add
.. automethod:: Model.put
.. automethod:: Model.insert
.. automethod:: Model.remove_module
.. automethod:: Model.pop_module
.. automethod:: Model.__getitem__
.. automethod:: Model.compile
.. automethod:: Model.get_output_shape
.. automethod:: Model.get_params
.. automethod:: Model.set_params
.. automethod:: Model.get_state
.. automethod:: Model.set_state
.. automethod:: Model.get_rng
.. automethod:: Model.set_rng
.. automethod:: Model._get_callable
.. automethod:: Model.__call__
.. automethod:: Model.predict
.. automethod:: Model.set_precision
.. automethod:: Model.astype
.. automethod:: Model.train
.. automethod:: Model.serialize
.. automethod:: Model.deserialize
.. automethod:: Model.save
.. automethod:: Model.save_compressed
.. automethod:: Model.load
.. automethod:: Model.from_file