Skip to content

braintrace-Add D-RTRL and pp-prop tutorials and update SNN quickstart#139

Open
poilsosart wants to merge 2 commits into
chaobrain:mainfrom
poilsosart:new01
Open

braintrace-Add D-RTRL and pp-prop tutorials and update SNN quickstart#139
poilsosart wants to merge 2 commits into
chaobrain:mainfrom
poilsosart:new01

Conversation

@poilsosart

@poilsosart poilsosart commented Jul 23, 2026

Copy link
Copy Markdown

Description

This PR corrects outdated or inaccurate D-RTRL and pp-prop documentation and updates compatibility examples to match the current BrainTrace API.

Changes

  • Correct the description of D-RTRL as a diagonal-Jacobian approximation rather than an exact BPTT-equivalent method.
  • Clarify that pp_prop is the canonical API name and ES_D_RTRL is retained as a compatibility alias.
  • Correct the semantics of integer decay_or_rank: it parameterizes the decay and does not allocate multiple low-rank trace factors.
  • Update the RNN and SNN quickstarts and related API documentation.
  • Remove obsolete mode=brainstate.mixin.Batching() arguments from examples.
  • Forward deprecated braintrace.nn state classes to brainpy.state and add a regression test.
  • Update the documented minimum Python version.

How Has This Been Tested

  • GitHub Actions test matrix passed with JAX 0.8, 0.9, 0.10, and latest.
  • Type checking and documentation build passed.
  • Codecov patch coverage passed at 100%.
  • No merge conflicts remain.

Types of Changes

  • Bug fix
  • Documentation
  • Compatibility update
  • Breaking change

Checklist

  • Necessary documentation has been updated.
  • Automated tests, type checks, and documentation build pass.
  • The changes are compatible with the current upstream main branch.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @poilsosart, your pull request is larger than the review limit of 150000 diff characters

@poilsosart poilsosart changed the title braintrace braintrace-Add D-RTRL and pp-prop tutorials and update SNN quickstart Jul 23, 2026
@poilsosart
poilsosart requested a review from chaoming0625 July 23, 2026 11:30
Align the documented Python version and brainpy.state forwarding with package metadata. Remove obsolete batching constructor arguments and correct D-RTRL/pp-prop assumptions without changing the upstream file layout.
@codecov

codecov Bot commented Jul 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant