docs: update examples and links to reflect changes in brainpy.state module

Author: chaoming0625

brainpy/inputs/currents.py

@@ -21,9 +21,12 @@
 
 __all__ = [
     'section_input',
-    'constant_input', 'constant_current',
-    'spike_input', 'spike_current',
-    'ramp_input', 'ramp_current',
+    'constant_input',
+    'constant_current',
+    'spike_input',
+    'spike_current',
+    'ramp_input',
+    'ramp_current',
     'wiener_process',
     'ou_process',
     'sinusoidal_input',

brainpy/state/_lif.py

@@ -74,12 +74,12 @@ class IF(Neuron):
 
     Examples
     --------
-    >>> import brainpy.state as brainpy
+    >>> import brainpy
     >>> import brainstate
     >>> import brainunit as u
     >>>
     >>> # Create an IF neuron layer with 10 neurons
-    >>> if_neuron = brainpy.IF(10, tau=8*u.ms, V_th=1.2*u.mV)
+    >>> if_neuron = brainpy.state.IF(10, tau=8*u.ms, V_th=1.2*u.mV)
     >>>
     >>> # Initialize the state
     >>> if_neuron.init_state(batch_size=1)
@@ -89,7 +89,7 @@ class IF(Neuron):
     >>>
     >>> # Create a network with IF neurons
     >>> network = brainstate.nn.Sequential([
-    ...     brainpy.IF(100, tau=5.0*u.ms),
+    ...     brainpy.state.IF(100, tau=5.0*u.ms),
     ...     brainstate.nn.Linear(100, 10)
     ... ])
 

docs_classic/index.rst

@@ -114,11 +114,12 @@ Learn more
          :link: https://brainmodeling.readthedocs.io
 
 
-.. note::
-   BrainPy is still an experimental research project.
-   APIs may be changed over time. Please always keeps
-   in mind what BrainPy version you are using.
+   .. grid-item::
+      :columns: 6 6 6 4
 
+      .. card:: :material-regular:`settings;2em` ``brainpy.state`` module
+         :class-card: sd-text-black sd-bg-light
+         :link: https://brainpy-state.readthedocs.io/
 
 
 ----

docs_state/index.rst

@@ -4,6 +4,14 @@
 `brainpy.state` provides a new ``State``-based programming paradigm for building and simulating spiking neural networks.
 
 
+Compared to ``brainpy.dyn``, ``brainpy.state`` provides:
+
+  - A more intuitive and flexible way to define and manage the state of neural network components (neurons, synapses, etc.).
+
+  - Improved performance and scalability for large-scale simulations.
+
+  - Seamless integration with `BrainX <https://brainmodeling.readthedocs.io>`_ ecosystem.
+
 
 .. note::
 

docs_state/quickstart/installation.rst

@@ -150,7 +150,7 @@ Getting Help
 If you encounter issues:
 
 - Check the `GitHub Issues <https://github.com/brainpy/BrainPy/issues>`_
-- Read the documentation at `https://brainpy.readthedocs.io/ <https://brainpy.readthedocs.io/>`_
+- Read the documentation at `https://brainpy-state.readthedocs.io/ <https://brainpy-state.readthedocs.io/>`_
 - Join our community discussions
 
 Next Steps