Skip to content

docs: verify README examples#18

Merged
kholdrex merged 1 commit into
mainfrom
docs/verify-readme-examples
May 31, 2026
Merged

docs: verify README examples#18
kholdrex merged 1 commit into
mainfrom
docs/verify-readme-examples

Conversation

@kholdrex
Copy link
Copy Markdown
Member

Summary

Refreshes the README examples so the public snippets compile against the current 0.8 API. Adds integration coverage for the documented examples to keep future API changes from silently drifting away from the README.

Changes

  • Updates the install snippet and several README examples for current LSTM, GRU, BiLSTM, linear-layer, training, early-stopping, and scheduler APIs.
  • Adds compile-oriented README example tests for early stopping, BiLSTM, GRU, linear layer, and advanced learning-rate scheduling.
  • Clarifies that placeholder validation data in examples should be replaced with held-out validation data in real applications.

Test plan

  • cargo fmt --all -- --check
  • cargo clippy --all-targets --all-features -- -D warnings
  • cargo test --all-features
  • cargo check --examples

@kholdrex kholdrex merged commit 80dc694 into main May 31, 2026
1 check passed
@kholdrex kholdrex deleted the docs/verify-readme-examples branch May 31, 2026 18:35
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