-
Notifications
You must be signed in to change notification settings - Fork 102
chore: update brainpy_state dependency to version 0.0.3 and enhance R… #814
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,3 +1,62 @@ | ||||||
| # ``brainpy.state`` README | ||||||
| # `brainpy.state` - State-based Brain Dynamics Programming | ||||||
|
|
||||||
| This module is being maintained by [brainpy_state](https://github.com/chaobrain/brainpy.state). | ||||||
| ## Overview | ||||||
|
|
||||||
| The `brainpy.state` module provides a state-based programming interface for brain dynamics modeling in BrainPy. This module is maintained as a separate package [`brainpy_state`](https://github.com/chaobrain/brainpy.state) and re-exported through BrainPy for seamless integration. | ||||||
|
|
||||||
| State-based programming offers an alternative paradigm for defining and managing neural models, emphasizing explicit state management and transformations for building complex brain dynamics systems. | ||||||
|
|
||||||
| ## Features | ||||||
|
|
||||||
| - **Explicit State Management**: Clear separation between model state and computation logic | ||||||
| - **Composable State Transformations**: Build complex models from simple, reusable state components | ||||||
| - **JAX-compatible**: Fully compatible with JAX's functional programming paradigm and JIT compilation | ||||||
| - **Hardware Acceleration**: Leverage CPU, GPU, and TPU acceleration through JAX backend | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nitpick (typo): Consider adding "the" before "JAX backend" for smoother grammar. For example: “Leverage CPU, GPU, and TPU acceleration through the JAX backend.”
Suggested change
|
||||||
|
|
||||||
| ## Documentation | ||||||
|
|
||||||
| For comprehensive documentation on state-based programming in BrainPy, please visit: | ||||||
|
|
||||||
| - **State-based Documentation**: https://brainpy-state.readthedocs.io/ | ||||||
| - **Main BrainPy Documentation**: https://brainpy.readthedocs.io/ | ||||||
|
|
||||||
| ## Source Repository | ||||||
|
|
||||||
| This module is maintained in a separate repository: | ||||||
|
|
||||||
| - **GitHub**: https://github.com/chaobrain/brainpy.state | ||||||
|
|
||||||
| ## Installation | ||||||
|
|
||||||
| The `brainpy.state` module is included when you install BrainPy: | ||||||
|
|
||||||
| ```bash | ||||||
| pip install brainpy -U | ||||||
| ``` | ||||||
|
|
||||||
| For development or to install the state module separately: | ||||||
|
|
||||||
| ```bash | ||||||
| pip install brainpy_state -U | ||||||
| ``` | ||||||
|
|
||||||
| ## Usage | ||||||
|
|
||||||
| Import the state module from BrainPy: | ||||||
|
|
||||||
| ```python | ||||||
| import brainpy as bp | ||||||
| from brainpy import state | ||||||
|
|
||||||
| # Use state-based components | ||||||
| # (See documentation for detailed examples) | ||||||
| ``` | ||||||
|
|
||||||
| ## Support | ||||||
|
|
||||||
| - **Bug Reports**: Please report issues at https://github.com/brainpy/BrainPy/issues | ||||||
| - **State Module Issues**: For state-specific issues, see https://github.com/chaobrain/brainpy.state/issues | ||||||
|
|
||||||
| ## License | ||||||
|
|
||||||
| Copyright 2025 BrainX Ecosystem Limited. Licensed under the Apache License, Version 2.0. | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (typo): Fix the typo "Moderize" → "Modernize".
Change the description to “Modernize BrainPy simulation with
brainstatesyntax.”