Skip to content

[DOCS] Add comprehensive API documentation for reservoirpy.nodes.Reservoir#28

Merged
drzo merged 2 commits intomainfrom
copilot/fix-27
Jun 8, 2025
Merged

[DOCS] Add comprehensive API documentation for reservoirpy.nodes.Reservoir#28
drzo merged 2 commits intomainfrom
copilot/fix-27

Conversation

Copy link
Copy Markdown

Copilot AI commented Jun 8, 2025

This PR implements comprehensive API documentation for the reservoirpy.nodes.Reservoir class as requested in issue #25.

Changes Made

Enhanced docs/source/api/generated/reservoirpy.nodes.Reservoir.rst with:

  • Complete class documentation with mathematical equations for internal/external update rules
  • Detailed parameter descriptions for all 34 parameters with proper type annotations
  • Comprehensive method listings using autosummary for all 30 methods
  • Complete attribute documentation for all 16 attributes
  • Practical examples showing usage with mackey_glass dataset
  • Proper cross-references to related modules (mat_gen, activationsfunc)

Documentation Structure

The documentation now includes:

  • Mathematical formulas showing the two reservoir update equations
  • Parameter tables with descriptions and default values
  • Complete method and attribute autosummary sections
  • Usage examples and code snippets
  • Proper Sphinx directives for HTML generation

Example

from reservoirpy.nodes import Reservoir
from reservoirpy.datasets import mackey_glass

# Create a 100-neuron reservoir
reservoir = Reservoir(100, lr=0.2, sr=0.8)

# Run on time series data
x = mackey_glass(200)
states = reservoir.run(x)

Validation

All documentation has been validated for:

  • ✅ RST syntax correctness
  • ✅ Sphinx directive compatibility
  • ✅ Mathematical equation formatting
  • ✅ Cross-reference links
  • ✅ Method/attribute completeness

The enhanced documentation provides a professional API reference that matches the comprehensive docstring already present in the Python source code (9600+ characters).

Fixes #25.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: drzo <15202748+drzo@users.noreply.github.com>
Copilot AI changed the title [WIP] @drzo Unfortunately I hit an unexpected error while trying to work on issue #25. I've automatically reported this to GitHub. [DOCS] Add comprehensive API documentation for reservoirpy.nodes.Reservoir Jun 8, 2025
Copilot AI requested a review from drzo June 8, 2025 09:24
Copilot finished work on behalf of drzo June 8, 2025 09:24
Copy link
Copy Markdown

@drzo drzo left a comment

Choose a reason for hiding this comment

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

docs

@drzo drzo marked this pull request as ready for review June 8, 2025 09:24
@drzo drzo merged commit b9cbf8a into main Jun 8, 2025
12 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.

[DOCS] Nodes - Reservoir

2 participants