Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc hierarchy update #630

Merged
merged 1 commit into from
Feb 22, 2024
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 45 additions & 6 deletions docs/advanced_tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,52 @@ Advanced Tutorials

This section contains tutorials that illustrate more advanced features of BrainPy.

Advanced Math
-------------

.. toctree::
:maxdepth: 2
:maxdepth: 1

tutorial_advanced/compilation.ipynb
tutorial_advanced/differentiation.ipynb


Interoperation
--------------

.. toctree::
:maxdepth: 1

tutorial_advanced/integrate_flax_into_brainpy.ipynb
tutorial_advanced/integrate_bp_lif_into_flax.ipynb
tutorial_advanced/integrate_bp_convlstm_into_flax.ipynb


Brain Dynamics Dedicated Operators
----------------------------------

.. toctree::
:maxdepth: 1

tutorial_advanced/operator_custom_with_numba.ipynb
tutorial_advanced/operator_custom_with_taichi.ipynb


Developer Guides
----------------

.. toctree::
:maxdepth: 1

tutorial_advanced/contributing.md


Others
------

.. toctree::
:maxdepth: 1

tutorial_advanced/advanced_lowdim_analysis.ipynb

tutorial_advanced/1_advanced_math.rst
tutorial_advanced/2_interoperation.rst
tutorial_advanced/3_dedicated_operators.rst
tutorial_advanced/4_developer_guides.rst
tutorial_advanced/5_others.rst

38 changes: 35 additions & 3 deletions docs/toolboxes.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
BDP Toolboxes
==================



This section contains detailed toolboxes BrainPy uses for brain dynamics modeling.



Differential Equations
-----------------------


.. toctree::
:maxdepth: 1

Expand All @@ -10,11 +19,34 @@ This section contains detailed toolboxes BrainPy uses for brain dynamics modelin
tutorial_toolbox/fde_numerical_solvers
tutorial_toolbox/dde_numerical_solvers
tutorial_toolbox/joint_equations


Toolbox for Modeling
-------------------

.. toctree::
:maxdepth: 1

tutorial_toolbox/synaptic_connections
tutorial_toolbox/synaptic_weights
tutorial_toolbox/inputs


Toolbox for Training
--------------------

.. toctree::
:maxdepth: 1

tutorial_toolbox/optimizers
tutorial_toolbox/state_saving_and_loading.ipynb
tutorial_toolbox/state_resetting.ipynb
tutorial_toolbox/surrogate_gradient
tutorial_toolbox/inputs


State Resetting, Saving and Loading
-----------------------------------

.. toctree::
:maxdepth: 1

tutorial_toolbox/state_saving_and_loading.ipynb
tutorial_toolbox/state_resetting.ipynb
77 changes: 71 additions & 6 deletions docs/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,76 @@ BDP Tutorials

This section contains tutorials on how to use BrainPy to accomplish model building, simulation, training, and analysis.


Math Foundation
---------------

.. toctree::
:maxdepth: 1

tutorial_math/variables
tutorial_math/control_flows
tutorial_math/Numpy_like_Operations.ipynb
tutorial_math/Dedicated_Operators.ipynb
tutorial_math/einops_in_brainpy.ipynb


Model Building with Existing Modules
------------------------------------

.. toctree::
:maxdepth: 1

tutorial_building/overview_of_dynamic_model
tutorial_building/build_conductance_neurons_v2.ipynb
tutorial_building/phenon_synapse_models.ipynb
tutorial_building/kinetic_synapse_models.ipynb
tutorial_building/build_network_models


Model Building by Customizing New Modules
-----------------------------------------

.. toctree::
:maxdepth: 1

tutorial_building/customize_neuron_models
tutorial_building/customize_synapse_models
tutorial_building/how_to_customze_a_synapse.ipynb


Model Simulation
----------------

.. toctree::
:maxdepth: 1

tutorial_simulation/simulation_dsrunner.ipynb
tutorial_simulation/parallel_for_parameter_exploration.ipynb
tutorial_simulation/monitor_per_multiple_steps.ipynb


Model Training
--------------

This tutorial shows how to train a dynamical system from data or task.

.. toctree::
:maxdepth: 1

tutorial_training/build_training_models.ipynb
tutorial_training/offline_training.ipynb
tutorial_training/online_training.ipynb
tutorial_training/bp_training.ipynb
tutorial_training/esn_introduction.ipynb


Model Analysis
--------------

.. toctree::
:maxdepth: 2
:maxdepth: 1

tutorial_math/index
tutorial_building/index
tutorial_simulation/index
tutorial_training/index
tutorial_analysis/index
tutorial_analysis/lowdim_analysis
tutorial_analysis/highdim_analysis
tutorial_analysis/decision_making_model