Skip to content

chore: generalise pre-existing roadmap-ish labels in implementation - #220

Merged
chrisjz merged 1 commit into
mainfrom
chore/generalise-roadmap-refs-in-impl
Jun 8, 2026
Merged

chore: generalise pre-existing roadmap-ish labels in implementation#220
chrisjz merged 1 commit into
mainfrom
chore/generalise-roadmap-refs-in-impl

Conversation

@chrisjz

@chrisjz chrisjz commented Jun 8, 2026

Copy link
Copy Markdown
Member

Small docs-only cleanup (no functional change) — removes ambiguous/planning labels from shipped docstrings/comments, per the convention that roadmap/tracking labels belong in planning artefacts, not implementation code.

Changes

  • LR / entropy schedule comments # Phase 1: Warmup / # Phase 2: Decay# Stage 1 / # Stage 2 in brain/arch/lstmppo.py, qliflstm.py, _reservoir_lstm_base.py. (These were algorithmic stages, not roadmap phases — but "Phase" is the ambiguous term to avoid.)
  • brain/arch/hybridquantumcortex.py module docstring: dropped the See logbook 008 for full evaluation. planning-artefact reference.

Context

These pre-existing references were surfaced while reviewing the Phase-6-T6 implementation (PR #219). Split into this separate PR to keep that change scoped to its own work.

Lint green (ruff / pyright / pre-commit).

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Refactor

    • Internal refactoring of brain architecture components with improved comment clarity for learning-rate scheduling phases.
  • Chores

    • Updated module documentation and removed outdated reference text.

Removes ambiguous/planning labels from shipped docstrings/comments (no functional
change):
- LR/entropy schedule comments "Phase 1: Warmup" / "Phase 2: Decay" → "Stage 1" /
  "Stage 2" in lstmppo.py, qliflstm.py, _reservoir_lstm_base.py (these were
  algorithmic stages, but "Phase" is the ambiguous term to avoid).
- hybridquantumcortex.py module docstring: dropped the "See logbook 008 for full
  evaluation." planning-artefact reference.

Surfaced during the Phase-6-T6 implementation review; split into its own PR to keep
that change scoped. Lint green (ruff/pyright).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 89907660-2a05-4267-a41e-13a2aae0e0bb

📥 Commits

Reviewing files that changed from the base of the PR and between d3d532d and 4f60868.

📒 Files selected for processing (4)
  • packages/quantum-nematode/quantumnematode/brain/arch/_reservoir_lstm_base.py
  • packages/quantum-nematode/quantumnematode/brain/arch/hybridquantumcortex.py
  • packages/quantum-nematode/quantumnematode/brain/arch/lstmppo.py
  • packages/quantum-nematode/quantumnematode/brain/arch/qliflstm.py

📝 Walkthrough

Walkthrough

This PR standardizes learning rate scheduling terminology across three brain implementations by renaming warmup and decay phases to "Stage 1" and "Stage 2", and removes an outdated reference from the hybrid quantum cortex module docstring.

Changes

Learning rate scheduling terminology standardization

Layer / File(s) Summary
Learning rate scheduling terminology standardization
packages/quantum-nematode/quantumnematode/brain/arch/_reservoir_lstm_base.py, packages/quantum-nematode/quantumnematode/brain/arch/lstmppo.py, packages/quantum-nematode/quantumnematode/brain/arch/qliflstm.py
Unified warmup and decay phase labels in _get_current_lr() methods to use consistent "Stage 1: Warmup" and "Stage 2: Decay" terminology across the reservoir LSTM base, LSTM PPO, and QLIF LSTM brain classes. Base implementation introduces a local ep = self._episode_count variable at method entry.
Module docstring cleanup
packages/quantum-nematode/quantumnematode/brain/arch/hybridquantumcortex.py
Removed outdated "See logbook 008 for full evaluation." text from module-level docstring.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Poem

🐰 A rabbit hops through stages bright,
Where warmup glows and decay takes flight,
Stage one, stage two, the labels gleam,
Standardized warmly in learning's dream! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: renaming ambiguous/roadmap labels (e.g., 'Phase' to 'Stage') and removing planning references from implementation code.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/generalise-roadmap-refs-in-impl

Comment @coderabbitai help to get the list of available commands and usage tips.

@chrisjz
chrisjz merged commit eacbc7a into main Jun 8, 2026
3 checks passed
@chrisjz
chrisjz deleted the chore/generalise-roadmap-refs-in-impl branch June 8, 2026 02:13
@codecov

codecov Bot commented Jun 8, 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