pyextal.jaxEngine.structureModel
================================

.. py:module:: pyextal.jaxEngine.structureModel


Attributes
----------

.. autoapisummary::

   pyextal.jaxEngine.structureModel._MODEL_REGISTRY


Functions
---------

.. autoapisummary::

   pyextal.jaxEngine.structureModel.register_model
   pyextal.jaxEngine.structureModel.get_model_by_name
   pyextal.jaxEngine.structureModel.list_registered_models
   pyextal.jaxEngine.structureModel.model_factory


Module Contents
---------------

.. py:data:: _MODEL_REGISTRY

.. py:function:: register_model(name: str)

   Decorator to register a model function with a given name.

   Usage:
       @register_model('my_model')
       def my_model_function(params, layer_idx=0):
           ...


.. py:function:: get_model_by_name(name: str) -> Callable

   Get a model function by its registered name.

   :param name: The registered name of the model

   :returns: The model function

   :raises ValueError: If the model name is not found in the registry


.. py:function:: list_registered_models() -> List[str]

   List all registered model names.


.. py:function:: model_factory(name: str) -> Callable

   Create a model function with fixed parameters for a specific layer.