brainstate 0.0.2.post20241010__py2.py3-none-any.whl → 0.1.0.post20241122__py2.py3-none-any.whl

brainstate/_state_test.py

@@ -16,26 +16,55 @@
 
 import unittest
 
-import brainstate as bc
+import jax
+import jax.numpy as jnp
+
+import brainstate as bst
 
 
 class TestStateSourceInfo(unittest.TestCase):
 
-  def test_state_source_info(self):
-    state = bc.State(bc.random.randn(10))
-    print(state._source_info)
+    def test_state_source_info(self):
+        state = bst.State(bst.random.randn(10))
+        print(state._source_info)
+
+    def test_state_value_tree(self):
+        state = bst.ShortTermState(jnp.zeros((2, 3)))
+
+        with bst.check_state_value_tree():
+            state.value = jnp.zeros((2, 3))
+
+            with self.assertRaises(ValueError):
+                state.value = (jnp.zeros((2, 3)), jnp.zeros((2, 3)))
+
+    def test_check_jax_tracer(self):
+        a = bst.ShortTermState(jnp.zeros((2, 3)))
+
+        @jax.jit
+        def run_state(b):
+            a.value = b
+            return a.value
+
+        # The following code will not raise an error, since the state is valid to trace.
+        run_state(jnp.ones((2, 3)))
+
+        with bst.check_state_jax_tracer():
+            # The line below will not raise an error.
+            with self.assertRaises(bst.util.TraceContextError):
+                # recompile the function
+                run_state(jnp.ones((2, 4)))
 
 
 class TestStateRepr(unittest.TestCase):
 
-  def test_state_repr(self):
-    print()
+    def test_state_repr(self):
+        print()
 
-    state = bc.State(bc.random.randn(10))
-    print(state)
+        state = bst.State(bst.random.randn(10))
+        print(state)
 
-    state2 = bc.State({'a': bc.random.randn(10), 'b': bc.random.randn(10)})
-    print(state2)
+        state2 = bst.State({'a': bst.random.randn(10), 'b': bst.random.randn(10)})
+        print(state2)
 
-    state3 = bc.State([bc.random.randn(10), bc.random.randn(10)])
-    print(state3)
+        state3 = bst.State([bst.random.randn(10), bst.random.randn(10)])
+        print(state3)

brainstate/_utils.py

@@ -13,9 +13,36 @@
 # limitations under the License.
 # ==============================================================================
 
+from __future__ import annotations
+
+import warnings
+
+
 def set_module_as(module: str):
-  def wrapper(fun: callable):
-    fun.__module__ = module
-    return fun
+    def wrapper(fun: callable):
+        fun.__module__ = module
+        return fun
+
+    return wrapper
+
+
+def _deprecate(msg):
+    warnings.simplefilter('always', DeprecationWarning)  # turn off filter
+    warnings.warn(msg, category=DeprecationWarning, stacklevel=2)
+    warnings.simplefilter('default', DeprecationWarning)  # reset filter
+
+
+def deprecation_getattr(module, deprecations):
+    def get_attr(name):
+        if name in deprecations:
+            old_name, new_name, fn = deprecations[name]
+            message = f"{old_name} is deprecated. "
+            if new_name is not None:
+                message += f'Use {new_name} instead.'
+            if fn is None:
+                raise AttributeError(message)
+            _deprecate(message)
+            return fn
+        raise AttributeError(f"module {module!r} has no attribute {name!r}")
 
-  return wrapper
+    return get_attr

brainstate/augment/__init__.py

@@ -0,0 +1,40 @@
+# Copyright 2024 BDP 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.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+
+"""
+This module includes transformations for augmenting the functionalities of JAX code.
+"""
+
+from ._autograd import *
+from ._autograd import __all__ as _autograd_all
+from ._eval_shape import *
+from ._eval_shape import __all__ as _eval_shape_all
+from ._mapping import *
+from ._mapping import __all__ as _mapping_all
+from ._random import *
+from ._random import __all__ as _random_all
+
+__all__ = (
+    _eval_shape_all
+    + _autograd_all
+    + _mapping_all
+    + _random_all
+)
+del (
+    _eval_shape_all,
+    _autograd_all,
+    _mapping_all,
+    _random_all
+)