Skip to content

Sync README with the estimators + Riemannian EEG changes - #5

Merged
aaygan29 merged 1 commit into
mainfrom
readme-sync
Aug 12, 2026
Merged

Sync README with the estimators + Riemannian EEG changes#5
aaygan29 merged 1 commit into
mainfrom
readme-sync

Conversation

@aaygan29

Copy link
Copy Markdown
Owner

The README update for the estimators/Riemannian work landed one commit too late and missed the PR #4 merge window, so main's README is currently stale (no "Per-modality estimators" section, old EEG modality row, Riemannian still listed as not-built). This cherry-picks that update onto main.

Brings the README in line with what's actually shipped:

  • "Per-modality estimators" section (elastic-net defaults, linear-SVM face alternative, the Riemannian tangent-space EEG path + covariance mode).
  • EEG modality-table row notes the covariance features.
  • Corrected docs/ and src/ layout lines (Riemannian is built, not "needs its own path").

Docs-only; no code change.

The README had drifted behind the code: it still described only plain-logistic
base learners and listed Riemannian as a not-yet-built idea. Now it documents
the elastic-net defaults, the linear-SVM face alternative, and the Riemannian
tangent-space EEG path (with the covariance feature mode), adds a "Per-modality
estimators" section, notes the EEG covariance option in the modality table, and
corrects the docs/ index. Keeping the README in sync with code changes going
forward.
@aaygan29
aaygan29 merged commit 76c30ba into main Aug 12, 2026
2 checks passed
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