Cpaniaguam/rlssm simplified interface

src/hssm/__init__.py

@@ -19,7 +19,7 @@
 from .param import UserParam as Param
 from .prior import Prior
 from .register import register_model
-from .rl import RLSSM
+from .rl import RLSSM, register_rlssm_model
 from .simulator import simulate_data
 from .utils import check_data_for_rl, set_floatX
 
@@ -40,6 +40,7 @@
     "Prior",
     "check_data_for_rl",
     "register_model",
+    "register_rlssm_model",
     "simulate_data",
     "set_floatX",
     "show_defaults",

src/hssm/hssm.py

@@ -51,34 +51,6 @@
 }
 
 
-class classproperty:
-    """A decorator that combines the behavior of @property and @classmethod.
-
-    This decorator allows you to define a property that can be accessed on the class
-    itself, rather than on instances of the class. It is useful for defining class-level
-    properties that need to perform some computation or access class-level data.
-
-    This implementation is provided for compatibility with Python versions 3.10 through
-    3.12, as one cannot combine the @property and @classmethod decorators is across all
-    these versions.
-
-    Example
-    -------
-    class MyClass:
-        @classproperty
-        def my_class_property(cls):
-            return "This is a class property"
-
-    print(MyClass.my_class_property)  # Output: This is a class property
-    """
-
-    def __init__(self, fget):
-        self.fget = fget
-
-    def __get__(self, instance, owner):  # noqa: D105
-        return self.fget(owner)
-
-
 class HSSM(HSSMBase):
     """The basic Hierarchical Sequential Sampling Model (HSSM) class.
 

src/hssm/rl/__init__.py

@@ -5,9 +5,12 @@
 
 Public API (import from ``hssm.rl``):
 
-- ``RLSSM``: the RL + SSM model class implemented in :mod:`hssm.rl.rlssm`.
-- ``RLSSMConfig``: the config class for RL + SSM models, implemented in
-  :mod:`hssm.rl.config`.
+- ``RLSSM``: the public RL + SSM model class in :mod:`hssm.rl.rlssm`.
+- ``_RLSSM``: the internal base class that requires a fully built config.
+- ``RLSSMConfig``: the config class for RL + SSM models in :mod:`hssm.rl.config`.
+- ``get_rlssm_model_config``: factory that builds a config from a named model.
+- ``register_rlssm_model``: register a custom named RLSSM model.
+- ``register_ssm``: register a custom SSM base logp function.
 - ``validate_balanced_panel``: panel-balance utility in :mod:`hssm.rl.utils`.
 
 RL likelihood builders live in :mod:`hssm.rl.likelihoods.builder` and include
@@ -17,11 +20,20 @@
 """
 
 from .config import RLSSMConfig
-from .rlssm import RLSSM
+from .registry import (
+    get_rlssm_model_config,
+    register_rlssm_model,
+    register_ssm,
+)
+from .rlssm import _RLSSM, RLSSM
 from .utils import validate_balanced_panel
 
 __all__ = [
     "RLSSM",
+    "_RLSSM",
     "RLSSMConfig",
+    "get_rlssm_model_config",
+    "register_rlssm_model",
+    "register_ssm",
     "validate_balanced_panel",
 ]