brainstate 0.1.9__py2.py3-none-any.whl → 0.2.0__py2.py3-none-any.whl

brainstate/nn/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2024 BDP Ecosystem Limited. All Rights Reserved.
+# Copyright 2024 BrainX Ecosystem Limited. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,8 +13,9 @@
 # limitations under the License.
 # ==============================================================================
 
-
-from . import metrics
+from . import init
+from ._activations import *
+from ._activations import __all__ as activation_all
 from ._collective_ops import *
 from ._collective_ops import __all__ as collective_ops_all
 from ._common import *
@@ -31,105 +32,106 @@ from ._elementwise import *
 from ._elementwise import __all__ as elementwise_all
 from ._embedding import *
 from ._embedding import __all__ as embed_all
+from ._event_fixedprob import *
+from ._event_fixedprob import __all__ as fixedprob_all
+from ._event_linear import *
+from ._event_linear import __all__ as linear_mv_all
 from ._exp_euler import *
 from ._exp_euler import __all__ as exp_euler_all
-from ._fixedprob import *
-from ._fixedprob import __all__ as fixedprob_all
-from ._inputs import *
-from ._inputs import __all__ as inputs_all
 from ._linear import *
 from ._linear import __all__ as linear_all
-from ._linear_mv import *
-from ._linear_mv import __all__ as linear_mv_all
-from ._ltp import *
-from ._ltp import __all__ as ltp_all
+from ._metrics import *
+from ._metrics import __all__ as metrics_all
 from ._module import *
 from ._module import __all__ as module_all
-from ._neuron import *
-from ._neuron import __all__ as dyn_neuron_all
 from ._normalizations import *
 from ._normalizations import __all__ as normalizations_all
-from ._others import *
-from ._others import __all__ as _others_all
+from ._paddings import *
+from ._paddings import __all__ as paddings_all
 from ._poolings import *
 from ._poolings import __all__ as poolings_all
-from ._projection import *
-from ._projection import __all__ as projection_all
-from ._rate_rnns import *
-from ._rate_rnns import __all__ as rate_rnns
-from ._readout import *
-from ._readout import __all__ as readout_all
-from ._stp import *
-from ._stp import __all__ as stp_all
-from ._synapse import *
-from ._synapse import __all__ as dyn_synapse_all
-from ._synaptic_projection import *
-from ._synaptic_projection import __all__ as _syn_proj_all
-from ._synouts import *
-from ._synouts import __all__ as synouts_all
+from ._rnns import *
+from ._rnns import __all__ as rate_rnns
 from ._utils import *
 from ._utils import __all__ as utils_all
 
-__all__ = (
-    [
-        'metrics',
-    ]
-    + collective_ops_all
-    + common_all
-    + elementwise_all
-    + module_all
-    + exp_euler_all
-    + utils_all
-    + dyn_all
-    + projection_all
-    + state_delay_all
-    + synouts_all
-    + conv_all
-    + linear_all
-    + normalizations_all
-    + poolings_all
-    + fixedprob_all
-    + linear_mv_all
-    + embed_all
-    + dropout_all
-    + elementwise_all
-    + dyn_neuron_all
-    + dyn_synapse_all
-    + inputs_all
-    + rate_rnns
-    + readout_all
-    + stp_all
-    + ltp_all
-    + _syn_proj_all
-    + _others_all
-)
+__all__ = ['init'] + activation_all + metrics_all
+__all__ = __all__ + collective_ops_all + common_all + elementwise_all + module_all + exp_euler_all
+__all__ = __all__ + utils_all + dyn_all + state_delay_all + conv_all
+__all__ = __all__ + linear_all + normalizations_all + paddings_all + poolings_all + fixedprob_all + linear_mv_all
+__all__ = __all__ + embed_all + dropout_all + elementwise_all
+__all__ = __all__ + rate_rnns
 
 del (
+    metrics_all,
+    activation_all,
     collective_ops_all,
     common_all,
     module_all,
     exp_euler_all,
     utils_all,
     dyn_all,
-    projection_all,
     state_delay_all,
-    synouts_all,
     conv_all,
     linear_all,
     normalizations_all,
+    paddings_all,
     poolings_all,
     embed_all,
     fixedprob_all,
     linear_mv_all,
     dropout_all,
     elementwise_all,
-    dyn_neuron_all,
-    dyn_synapse_all,
-    inputs_all,
-    readout_all,
     rate_rnns,
-    stp_all,
-    ltp_all,
-    _syn_proj_all,
-    _others_all,
 )
+
+# Deprecated names that redirect to brainpy
+_DEPRECATED_NAMES = {
+    'SpikeTime': 'brainpy.SpikeTime',
+    'PoissonSpike': 'brainpy.PoissonSpike',
+    'PoissonEncoder': 'brainpy.PoissonEncoder',
+    'PoissonInput': 'brainpy.PoissonInput',
+    'poisson_input': 'brainpy.poisson_input',
+    'Neuron': 'brainpy.Neuron',
+    'IF': 'brainpy.IF',
+    'LIF': 'brainpy.LIF',
+    'LIFRef': 'brainpy.LIFRef',
+    'ALIF': 'brainpy.ALIF',
+    'LeakyRateReadout': 'brainpy.LeakyRateReadout',
+    'LeakySpikeReadout': 'brainpy.LeakySpikeReadout',
+    'STP': 'brainpy.STP',
+    'STD': 'brainpy.STD',
+    'Synapse': 'brainpy.Synapse',
+    'Expon': 'brainpy.Expon',
+    'DualExpon': 'brainpy.DualExpon',
+    'Alpha': 'brainpy.Alpha',
+    'AMPA': 'brainpy.AMPA',
+    'GABAa': 'brainpy.GABAa',
+    'COBA': 'brainpy.COBA',
+    'CUBA': 'brainpy.CUBA',
+    'MgBlock': 'brainpy.MgBlock',
+    'SynOut': 'brainpy.SynOut',
+    'AlignPostProj': 'brainpy.AlignPostProj',
+    'DeltaProj': 'brainpy.DeltaProj',
+    'CurrentProj': 'brainpy.CurrentProj',
+    'align_pre_projection': 'brainpy.align_pre_projection',
+    'Projection': 'brainpy.Projection',
+    'SymmetryGapJunction': 'brainpy.SymmetryGapJunction',
+    'AsymmetryGapJunction': 'brainpy.AsymmetryGapJunction',
+}
+
+
+def __getattr__(name: str):
+    if name in _DEPRECATED_NAMES:
+        import warnings
+        new_name = _DEPRECATED_NAMES[name]
+        warnings.warn(
+            f"'brainstate.nn.{name}' is deprecated and will be removed in a future version. "
+            f"Please use '{new_name}' instead.",
+            DeprecationWarning,
+            stacklevel=2
+        )
+        # Import and return the actual brainpy object
+        import brainpy
+        return getattr(brainpy, name)
+    raise AttributeError(f"module 'brainstate.nn' has no attribute '{name}'")