Skip to content

Fix documentation consistency: references, CHANGELOG, and landing page#10

Merged
bruAristimunha merged 6 commits into
mainfrom
fix/phasespdnet-missing-references
Feb 17, 2026
Merged

Fix documentation consistency: references, CHANGELOG, and landing page#10
bruAristimunha merged 6 commits into
mainfrom
fix/phasespdnet-missing-references

Conversation

@bruAristimunha

@bruAristimunha bruAristimunha commented Feb 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Summary

Comprehensive documentation consistency fixes across CHANGELOG, landing page, and references.

CHANGELOG.md

  • Fix model name GREEN to Green
  • Remove 4 non-existent layers (SqrtEig, InvSqrtEig, PowerEig, VecMat)
  • Add 10 missing layers (BiMapIncreaseDim, SPDDropout, LogEuclideanResidual, TraceNorm, WaveletConv, PatchEmbeddingLayer, Vec, Vech) and manifold parametrizations (SymmetricPositiveDefinite, PositiveDefiniteScalar)
  • Replace 5 fictional batch norm names with 3 actual classes (SPDBatchNormMean, SPDBatchNormMeanVar, BatchReNorm)
  • Fix all functional operation names to match code (matrix_log not logm, sample_covariance not scm, etc.)
  • Add missing functional categories (Frechet derivatives, parallel transport variants, adversarial, wavelets, numerical stability)
  • Correct parallel transport claims per metric (Bures-Wasserstein provides optimal transport, not parallel transport)

Landing page (index.rst)

  • Add missing MAtt model card with architecture image and component tags
  • Add publication venue badges to all 7 model cards (AAAI, NeurIPS, IEEE TNNLS, J. Neural Eng., Patterns, Imaging Neuroscience)
  • Fix GREEN to Green in card title
  • Sort model cards by publication year

References

  • Fix PhaseSPDNet description and add missing citation (Carrara et al., 2024)

Test plan

  • make html-noplot builds successfully
  • All class/function names in CHANGELOG verified against codebase
  • All 7 model cards render on landing page with venue badges

Closes #9

@bruAristimunha
Fix PhaseSPDNet missing references and inaccurate description
6efeb7c 
Update CHANGELOG.md to correct PhaseSPDNet description (phase-space
embedding, not instantaneous phase) and add missing citation. Add
PhaseSPDNet BibTeX entry to references.rst convenience section.

Closes #9
@github-actions

github-actions Bot commented Feb 17, 2026 •
edited
Loading

Copy link
Copy Markdown

📚 Documentation Preview

📦 Download Documentation Artifact

Download the documentation-html artifact from the workflow run to view the docs locally.

💡 To enable live previews, add a SURGE_TOKEN secret to this repository. See surge.sh for setup instructions.

@bruAristimunha
reviewing the change log
67a545b
@bruAristimunha
Fix CHANGELOG.md to accurately reflect the codebase
fb6a045 
- Fix model name GREEN → Green
- Remove 4 non-existent layers (SqrtEig, InvSqrtEig, PowerEig, VecMat)
- Add 10 missing layers and new Manifold Parametrizations section
- Replace 5 fictional batch norm names with 3 actual classes
- Correct parallel transport claims per metric
- Fix all functional operation names to match actual code
- Add missing functional categories (Fréchet derivatives, adversarial,
  wavelets, numerical stability, etc.)
@bruAristimunha
Add MAtt model card to landing page and fix Green naming
9917425 
- Add missing MAtt card to the Model Architectures grid with
  architecture image and tags (Attention, LogEuclidean, TraceNorm)
- Fix GREEN → Green to match actual class name
@bruAristimunha
Add publication venue badges to model cards
0908461 
Add a distinct venue badge (hf-venue) to each model card on the landing
page showing where the paper was published (AAAI, NeurIPS, IEEE TNNLS,
J. Neural Eng., Patterns, Imaging Neuroscience).
@bruAristimunha
Sort model cards by publication year on landing page
efaa6ba
@bruAristimunha bruAristimunha changed the title Fix PhaseSPDNet missing references and inaccurate description Fix documentation consistency: references, CHANGELOG, and landing page Feb 17, 2026
@bruAristimunha
bruAristimunha merged commit 1b14174 into main Feb 17, 2026
11 checks passed
@bruAristimunha
bruAristimunha deleted the fix/phasespdnet-missing-references branch February 17, 2026 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve documentation consistency: references, CHANGELOG, and landing page

1 participant

@bruAristimunha