brainstate 0.1.0.post20250217__py2.py3-none-any.whl → 0.1.0.post20250218__py2.py3-none-any.whl

brainstate/_state.py

@@ -44,7 +44,12 @@ from brainstate.util import DictManager, PrettyObject
 from brainstate.util.filter import Nothing
 
 __all__ = [
-    'State', 'ShortTermState', 'LongTermState', 'HiddenState', 'ParamState', 'TreefyState',
+    'State',
+    'ShortTermState',
+    'LongTermState',
+    'HiddenState',
+    'ParamState',
+    'TreefyState',
     'FakeState',
 
     'StateDictManager',
@@ -956,21 +961,18 @@ class BatchState(LongTermState):
 
 class HiddenState(ShortTermState):
     """
-    The hidden state, which is used to store the hidden data in a dynamic model.
+     Represents hidden state variables in neurons or synapses.
 
     This class extends :class:`ShortTermState` and is specifically designed to represent
     and manage hidden states within dynamic models, such as recurrent neural networks.
     It provides a way to encapsulate hidden state values and associated metadata,
     facilitating operations like state updates during model execution.
 
-    Attributes:
-        Inherits all attributes from :class:`ShortTermState`.
-
     Note:
-        This class does not introduce new methods or attributes beyond those
-        inherited from :class:`ShortTermState`. Its primary purpose is to semantically
-        distinguish hidden states from other types of short-term states
-        in dynamic models.
+        :class:`HiddenState` and :class:`ParamState` are two most important state types
+        in brainstate. The former is used to store the hidden states in neurons, synapses,
+        or networks. The latter is used to store the trainable parameters in the model,
+        such as synaptic weights.
 
     Example:
         >>> lstm_hidden = HiddenState(np.zeros(128), name="lstm_hidden_state")
@@ -989,14 +991,11 @@ class ParamState(LongTermState):
     It provides a way to encapsulate parameter values and associated metadata,
     facilitating operations like parameter updates during training.
 
-    Attributes:
-        Inherits all attributes from :class:`LongTermState`.
-
     Note:
-        This class does not introduce new methods or attributes beyond those
-        inherited from :class:`LongTermState`. Its primary purpose is to semantically
-        distinguish parameter states from other types of long-term states
-        in the model.
+        :class:`HiddenState` and :class:`ParamState` are two most important state types
+        in brainstate. The former is used to store the hidden states in neurons, synapses,
+        or networks. The latter is used to store the trainable parameters in the model,
+        such as synaptic weights.
 
     Example:
         >>> weight = ParamState(np.random.randn(10, 10), name="layer1_weights")

{brainstate-0.1.0.post20250217.dist-info → brainstate-0.1.0.post20250218.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: brainstate
-Version: 0.1.0.post20250217
+Version: 0.1.0.post20250218
 Summary: A ``State``-based Transformation System for Program Compilation and Augmentation.
 Home-page: https://github.com/chaobrain/brainstate
 Author: BrainState Developers

{brainstate-0.1.0.post20250217.dist-info → brainstate-0.1.0.post20250218.dist-info}/RECORD

@@ -1,5 +1,5 @@
 brainstate/__init__.py,sha256=AkZyyFkn4fB8g2aT6Rc2MO1xICPpUZuDtdze-eUQNc0,1496
-brainstate/_state.py,sha256=5Oc-QPyQbfwUSAiTTa9BYh64QKI3xL54nvGwQr2KHBs,60827
+brainstate/_state.py,sha256=KJclcHKGrIt8K_rDW3E2dO8g_f_UMcZwGID4UUb9MBE,60751
 brainstate/_state_test.py,sha256=UBbbGJ8cb9dJ3NeySf-TNs_nNP47Ax8CP7QL_b32MAA,1636
 brainstate/_utils.py,sha256=uJ6WWKq3yb05ZdktCQGLWOXsOJveL1H9pR7eev70Jes,1693
 brainstate/environ.py,sha256=PllYYZKqany3G7NzIwoUPplLAePbyza6kJGXTPgJK-c,17698
@@ -121,8 +121,8 @@ brainstate/util/_pretty_table.py,sha256=NM_6VAW6oL9jojsK0-RkQGHnDzLy_fn_hgzl5R8o
 brainstate/util/_scaling.py,sha256=pc_eM_SZVwkY65I4tJh1ODiHNCoEhsfFXl2zBK0PLAg,7562
 brainstate/util/_struct.py,sha256=F5GfFURITAIYTwf17_xypkZU1wvoL4dUCviPnr_eCtw,17515
 brainstate/util/filter.py,sha256=Zw0H42NwAi2P7dBr3ISv2VpkB5jqoWnV4Kpd61gq66o,14126
-brainstate-0.1.0.post20250217.dist-info/LICENSE,sha256=VZe9u1jgUL2eCY6ZPOYgdb8KCblCHt8ECdbtJid6e1s,11550
-brainstate-0.1.0.post20250217.dist-info/METADATA,sha256=eBHppB4DxysakCjcinzG4vVSxI_eS08l7LkSepmGGXI,3585
-brainstate-0.1.0.post20250217.dist-info/WHEEL,sha256=bb2Ot9scclHKMOLDEHY6B2sicWOgugjFKaJsT7vwMQo,110
-brainstate-0.1.0.post20250217.dist-info/top_level.txt,sha256=eQbGgKn0ptx7FDWuua0V0wr4K1VHi2iOUCYo3fUQBRA,11
-brainstate-0.1.0.post20250217.dist-info/RECORD,,
+brainstate-0.1.0.post20250218.dist-info/LICENSE,sha256=VZe9u1jgUL2eCY6ZPOYgdb8KCblCHt8ECdbtJid6e1s,11550
+brainstate-0.1.0.post20250218.dist-info/METADATA,sha256=INsdNphwnxGh07Urn2gjiOYzPEEQ8Lcr19bugHUYrU4,3585
+brainstate-0.1.0.post20250218.dist-info/WHEEL,sha256=bb2Ot9scclHKMOLDEHY6B2sicWOgugjFKaJsT7vwMQo,110
+brainstate-0.1.0.post20250218.dist-info/top_level.txt,sha256=eQbGgKn0ptx7FDWuua0V0wr4K1VHi2iOUCYo3fUQBRA,11
+brainstate-0.1.0.post20250218.dist-info/RECORD,,