Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Documentation
documentation:
- changed-files:
- any-glob-to-any-file: ['docs_version2_version2/**/*', 'docs_version2/**/*', '**/*.md', '**/*.rst']
- any-glob-to-any-file: ['docs_version2_version2/**/*', 'docs_classic/**/*', '**/*.md', '**/*.rst']

# CI/CD
ci-cd:
Expand Down
68 changes: 34 additions & 34 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,34 +24,34 @@ extensions/cmake-build-debug
BrainPyExamples/
BrainModels/
book/
docs_version2/examples
docs_version2/apis/jaxsetting.rst
docs_version2/quickstart/data
docs_classic/examples
docs_classic/apis/jaxsetting.rst
docs_classic/quickstart/data
examples/recurrent_neural_network/neurogym
develop/iconip_paper
develop/benchmark/COBA/results
develop/test
develop/outputdir
docs_version2/tutorial_math/data
docs_version2/tutorial_simulation/data
docs_classic/tutorial_math/data
docs_classic/tutorial_simulation/data

docs_version2/images/numpybrain_arch.pptx
docs_version2/images/synapses_index.pdf
docs_version2/images/synapses_index.xlsx
docs_version2/images/neuron_structure.xlsx
docs_version2/images/neuron_structure.pdf
docs_version2/images/connection_methods.pptx
docs_classic/images/numpybrain_arch.pptx
docs_classic/images/synapses_index.pdf
docs_classic/images/synapses_index.xlsx
docs_classic/images/neuron_structure.xlsx
docs_classic/images/neuron_structure.pdf
docs_classic/images/connection_methods.pptx

*/_autosummary
*/generated

docs_version2/apis/auto
docs_version2/quickstart/.ipynb_checkpoints
docs_classic/apis/auto
docs_classic/quickstart/.ipynb_checkpoints

docs_version2/apis/_autosummary
docs_version2/apis/generated
docs_version2/apis/math/generated
docs_version2/apis/integrators/generated
docs_classic/apis/_autosummary
docs_classic/apis/generated
docs_classic/apis/math/generated
docs_classic/apis/integrators/generated

develop/benchmark/COBA/brian2*
develop/benchmark/COBA/annarchy*
Expand All @@ -65,20 +65,20 @@ develop/benchmark/CUBA/brian2*
\#*\#
*.pyc
.DS_Store
docs_version2/_autosummary
docs_version2/generated
docs_version2/_build
docs_classic/_autosummary
docs_classic/generated
docs_classic/_build
dist/
build/
*.egg-info
.idea
docs_version2/images/logo1.tif
docs_version2/images/logo2.tif
docs_version2/images/logo3.tif
docs_version2/images/logo4.tif
docs_classic/images/logo1.tif
docs_classic/images/logo2.tif
docs_classic/images/logo3.tif
docs_classic/images/logo4.tif

*/__pycache__
docs_version2/c4_examples/
docs_classic/c4_examples/


__pycache__/
Expand Down Expand Up @@ -148,7 +148,7 @@ instance/
.scrapy

# Sphinx documentation
docs_version2/_build/
docs_classic/_build/

# PyBuilder
.pybuilder/
Expand Down Expand Up @@ -216,25 +216,25 @@ dmypy.json
# Cython debug symbols
cython_debug/

/docs_version2/apis/simulation/generated/
/docs_classic/apis/simulation/generated/
!/brainpy/dyn/tests/data/
/examples/dynamics_simulation/data/
/examples/training_snn_models/logs/T100_b64_lr0.001/
/examples/training_snn_models/logs/
/examples/training_snn_models/data/
/docs_version2/tutorial_advanced/data/
/docs_classic/tutorial_advanced/data/
/my_tests/
/examples/dynamics_simulation/Joglekar_2018_data/
/docs_version2/apis/deprecated/generated/
/docs_classic/apis/deprecated/generated/
/bugs/
/dev/
/.claude/
/docs_version2/_static/logos/
/docs_classic/_static/logos/
/docs/_static/logos/
/docs/_build/
/docs/changelog.md
/docs_state_based/_build/
/docs_state_based/_static/logos/
/docs_state_based/changelog.md
/examples_version2/dynamics_training/data/
/docs_state/_build/
/docs_state/_static/logos/
/docs_state/changelog.md
/examples_classic/dynamics_training/data/
/docs/
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,6 @@ BrainPy is a flexible, efficient, and extensible framework for computational neu
- **Ecosystem**: https://brainmodeling.readthedocs.io/


``BrainPy>=3.0.0`` is rewritten based on [brainstate](https://github.com/chaobrain/brainstate) since August 2025, please learn [brainstate documentation](https://brainstate.readthedocs.io/) for the latest updates.


## Installation

BrainPy is based on Python (>=3.10) and can be installed on Linux (Ubuntu 16.04 or later), macOS (10.12 or later), and Windows platforms.
Expand Down
3 changes: 2 additions & 1 deletion brainpy/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@
ArrayCollector as ArrayCollector,
Collector as Collector,
)

from brainpy import state

from brainpy.deprecations import deprecation_getattr

Expand All @@ -151,6 +151,7 @@


if __name__ == '__main__':
state
connect
initialize, # weight initialization
optim, # gradient descent optimizers
Expand Down
9 changes: 6 additions & 3 deletions brainpy/inputs/currents.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,4 @@

if __name__ == '__main__':
mixin

8 changes: 4 additions & 4 deletions brainpy/state_based/_base.py → brainpy/state/_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ class Synapse(brainstate.nn.Dynamics):

.. code-block:: python

>>> import brainpy.state_based as brainpy
>>> import brainpy.state as brainpy
>>> import brainstate
>>> import brainunit as u
>>> import braintools
Expand Down Expand Up @@ -343,7 +343,7 @@ class Synapse(brainstate.nn.Dynamics):

.. code-block:: python

>>> import brainpy.state_based as brainpy
>>> import brainpy.state as brainpy
>>> import brainstate
>>> import brainunit as u
>>> import jax
Expand All @@ -368,7 +368,7 @@ class Synapse(brainstate.nn.Dynamics):

.. code-block:: python

>>> import brainpy.state_based as brainpy
>>> import brainpy.state as brainpy
>>> import brainstate
>>> import brainunit as u
>>>
Expand Down Expand Up @@ -409,7 +409,7 @@ class Synapse(brainstate.nn.Dynamics):

.. code-block:: python

>>> import brainpy.state_based as brainpy
>>> import brainpy.state as brainpy
>>> import brainstate
>>> import brainunit as u
>>>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import brainunit as u
import jax.numpy as jnp

from brainpy.state_based import Neuron, Synapse
from brainpy.state import Neuron, Synapse


class TestNeuronBaseClass(unittest.TestCase):
Expand Down
File renamed without changes.
File renamed without changes.
12 changes: 6 additions & 6 deletions brainpy/state_based/_lif.py → brainpy/state/_lif.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,12 @@ class IF(Neuron):

Examples
--------
>>> import brainpy.state_based 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)
Expand All @@ -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)
... ])

Expand Down Expand Up @@ -207,7 +207,7 @@ class LIF(Neuron):

Examples
--------
>>> import brainpy.state_based as brainpy
>>> import brainpy.state as brainpy
>>> import brainstate
>>> import brainunit as u
>>>
Expand Down Expand Up @@ -344,7 +344,7 @@ class LIFRef(Neuron):

Examples
--------
>>> import brainpy.state_based as brainpy
>>> import brainpy.state as brainpy
>>> import brainstate
>>> import brainunit as u
>>>
Expand Down Expand Up @@ -512,7 +512,7 @@ class ALIF(Neuron):

Examples
--------
>>> import brainpy.state_based as brainpy
>>> import brainpy.state as brainpy
>>> import brainstate
>>> import brainunit as u
>>>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import jax
import jax.numpy as jnp

from brainpy.state_based import IF, LIF, ALIF
from brainpy.state import IF, LIF, ALIF


class TestNeuron(unittest.TestCase):
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import brainunit as u
import jax.numpy as jnp

import brainpy.state_based as brainpy
import brainpy.state as brainpy


class TestReadoutModels(unittest.TestCase):
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import jax.numpy as jnp
import pytest

from brainpy.state_based import Expon, STP, STD
from brainpy.state import Expon, STP, STD


class TestSynapse(unittest.TestCase):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ class AsymmetryGapJunction(Projection):

Examples
--------
>>> import brainpy.state_based as brainpy
>>> import brainpy.state as brainpy
>>> import brainunit as u
>>> import numpy as np
>>>
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import jax.numpy as jnp
import numpy as np

import brainpy.state_based as brainpy
import brainpy.state as brainpy


class TestSynOutModels(unittest.TestCase):
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@
build_version = os.environ.get('CURRENT_VERSION', 'v2')
if build_version == 'v2':
shutil.copytree(
os.path.join(os.path.dirname(__file__), '../docs_version2'),
os.path.join(os.path.dirname(__file__), '../docs_classic'),
os.path.join(os.path.dirname(__file__)),
dirs_exist_ok=True
)
else:
shutil.copytree(
os.path.join(os.path.dirname(__file__), '../docs_state_based'),
os.path.join(os.path.dirname(__file__), '../docs_state'),
os.path.join(os.path.dirname(__file__)),
dirs_exist_ok=True
)
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs_version2/README.md → docs_classic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import brainpy.math as bm
This documentation is written in reStructuredText (RST) format and can be built using Sphinx:

```bash
cd docs_version2
cd docs_classic
make html # or use the appropriate build script
```

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
9 changes: 5 additions & 4 deletions docs_version2/index.rst → docs_classic/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/


----
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading
Loading