Docs (#790)

* refactor(docs): rename documentation and state-based files for consistency

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

Author: chaoming0625

.github/labeler.yml

@@ -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:

.gitignore

@@ -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*
@@ -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__/
@@ -148,7 +148,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs_version2/_build/
+docs_classic/_build/
 
 # PyBuilder
 .pybuilder/
@@ -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/

README.md

@@ -142,7 +142,7 @@
     ArrayCollector as ArrayCollector,
     Collector as Collector,
 )
-
+from brainpy import state
 
 from brainpy.deprecations import deprecation_getattr
 
@@ -151,6 +151,7 @@
 
 
 if __name__ == '__main__':
+    state
     connect
     initialize,  # weight initialization
     optim,  # gradient descent optimizers

brainpy/__init__.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/inputs/currents.py

@@ -43,3 +43,4 @@
 
 if __name__ == '__main__':
     mixin
+

brainpy/state_based/__init__.py brainpy/state/__init__.pybrainpy/state_based/__init__.py renamed to brainpy/state/__init__.py

@@ -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
@@ -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
@@ -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
         >>>
@@ -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
         >>>

brainpy/state_based/_base.py brainpy/state/_base.pybrainpy/state_based/_base.py renamed to brainpy/state/_base.py

@@ -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):