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

brainstate/optim/__init__.py

@@ -14,6 +14,8 @@
 # ==============================================================================
 
 
+from ._base import *
+from ._base import __all__ as base_all
 from ._lr_scheduler import *
 from ._lr_scheduler import __all__ as scheduler_all
 from ._optax_optimizer import *
@@ -21,6 +23,16 @@ from ._optax_optimizer import __all__ as optax_all
 from ._sgd_optimizer import *
 from ._sgd_optimizer import __all__ as optimizer_all
 
-__all__ = scheduler_all + optimizer_all + optax_all
+__all__ = (
+    base_all
+    + scheduler_all
+    + optimizer_all
+    + optax_all
+)
 
-del optax_all, scheduler_all, optimizer_all
+del (
+    base_all,
+    optax_all,
+    scheduler_all,
+    optimizer_all,
+)

brainstate/optim/_base.py

@@ -0,0 +1,66 @@
+# 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.
+# ==============================================================================
+
+
+from __future__ import annotations
+
+from typing import Dict, Hashable
+
+from brainstate._state import State, StateDictManager
+from brainstate.graph import Node
+from brainstate.typing import PyTree
+
+__all__ = [
+    'Optimizer',
+]
+
+
+class Optimizer(Node):
+    """
+    Base Optimizer Class.
+
+    Attributes:
+    -----------
+    param_states: StateDictManager
+        The state dict manager for trainable weights.
+
+    """
+
+    param_states: StateDictManager
+
+    def __init__(self):
+        self.param_states = StateDictManager()
+
+    def register_trainable_weights(self, param_states: Dict[Hashable, State]):
+        """
+        Register the trainable weights.
+
+        Parameters:
+        -----------
+        param_states: Dict[Hashable, State]
+            The trainable weights.
+        """
+        raise NotImplementedError
+
+    def update(self, grads: Dict[Hashable, PyTree]):
+        """
+        Update the trainable weights according to weight gradients.
+
+        Parameters:
+        -----------
+        grads: Dict[Hashable, PyTree]
+            The weight gradients.
+        """
+        raise NotImplementedError