-
Notifications
You must be signed in to change notification settings - Fork 101
Refactor V2 tests to tests_version2 and add V2/V3 documentation READMEs #788
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
Conversation
Reviewer's GuideThis PR standardizes the Version 2 test suite by renaming all test references from "tests" to "tests_version2" across CI workflows, documentation, and code comments, and augments the repository with dedicated example and documentation READMEs for both Version 2 and Version 3. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Hey there - I've reviewed your changes and they look great!
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `examples_version2/README.md:65-68` </location>
<code_context>
+Spiking neural network training examples:
+
+- **spikebased_bp_for_cifar10.py** - Spike-based backpropagation for CIFAR-10
+- **readme.md** - Additional SNN training documentation
+
+## Requirements
</code_context>
<issue_to_address>
**suggestion:** 'readme.md' is listed as an example script, but it's a documentation file.
Please remove 'readme.md' from the example scripts list to avoid confusion.
```suggestion
Spiking neural network training examples:
- **spikebased_bp_for_cifar10.py** - Spike-based backpropagation for CIFAR-10
```
</issue_to_address>
### Comment 2
<location> `examples_version3/README.md:20` </location>
<code_context>
+- **104_CUBA_2005.py** - Current-based E/I network (CUBA model)
+- **106_COBA_HH_2007.py** - COBA network with Hodgkin-Huxley neurons
+- **107_gamma_oscillation_1996.py** - Gamma oscillation generation
+- **108_synfire_chains_199.py** - Synfire chain propagation
+- **109_fast_global_oscillation.py** - Fast global oscillation dynamics
+
</code_context>
<issue_to_address>
**issue (typo):** Filename '108_synfire_chains_199.py' may contain a typo in the year.
Please verify and correct the year in the filename to ensure consistency with the other files.
```suggestion
- **108_synfire_chains_1991.py** - Synfire chain propagation
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| Spiking neural network training examples: | ||
|
|
||
| - **spikebased_bp_for_cifar10.py** - Spike-based backpropagation for CIFAR-10 | ||
| - **readme.md** - Additional SNN training documentation |
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.
suggestion: 'readme.md' is listed as an example script, but it's a documentation file.
Please remove 'readme.md' from the example scripts list to avoid confusion.
| Spiking neural network training examples: | |
| - **spikebased_bp_for_cifar10.py** - Spike-based backpropagation for CIFAR-10 | |
| - **readme.md** - Additional SNN training documentation | |
| Spiking neural network training examples: | |
| - **spikebased_bp_for_cifar10.py** - Spike-based backpropagation for CIFAR-10 |
| - **104_CUBA_2005.py** - Current-based E/I network (CUBA model) | ||
| - **106_COBA_HH_2007.py** - COBA network with Hodgkin-Huxley neurons | ||
| - **107_gamma_oscillation_1996.py** - Gamma oscillation generation | ||
| - **108_synfire_chains_199.py** - Synfire chain propagation |
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): Filename '108_synfire_chains_199.py' may contain a typo in the year.
Please verify and correct the year in the filename to ensure consistency with the other files.
| - **108_synfire_chains_199.py** - Synfire chain propagation | |
| - **108_synfire_chains_1991.py** - Synfire chain propagation |
docs: update documentation links for BrainPy 3.0 and 2.0
|
@sourcery-ai title |
Summary by Sourcery
Harmonize BrainPy version2 test suite by renaming the tests directory to tests_version2 and update all related references in code, CI, documentation, and examples, while adding dedicated README files for version2 and version3 documentation and examples
New Features:
Enhancements:
CI:
Documentation: