Skip to content

Issue 3 β€” [Docs] Add Example Notebooks in examples/Β #4

Description

@leenathomas01

[Docs] Add Example Notebooks in examples/

πŸ“Œ Motivation

Interactive examples help new users understand the toolkit quickly.
Jupyter notebooks also enable reproducible benchmarking and visualization.

🎯 Goal

  • Create an examples/ folder
  • Add Jupyter notebooks demonstrating:
    • Running the FxLMS prototype
    • Plotting convergence curves
    • Benchmarking SINR improvement
  • Keep dependencies minimal (numpy, matplotlib)

πŸ’‘ Potential Approaches

  • Start with one notebook: 01_basic_demo.ipynb
  • Use simple synthetic signals for illustration
  • Add visualizations (before vs. after cancellation)

βœ… Expected Outcomes

  • At least one working notebook in examples/
  • Visual plots that match the README performance highlights

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions