Skip to content

API reference

Auto-generated from docstrings via mkdocstrings. Each subpackage has its own page:

  • Core - App, Context, Stream, StreamInfo, Px/Fr/Grid, EdgeTrigger, TrainingData, virtual_hand, contrib.features, install_vhi.
  • Sources - LSLSource, ReplaySource, SerialSource.
  • Outputs - Output, LSLOutlet, UDPOutput, SerialOutput.
  • ML pipeline - Pipeline, save_pickle, load_pickle, ML widgets.
  • Widgets - every public widget function.
  • Models - CatBoost / scikit-learn constructor recipes, persistence helpers.
  • Session - open_session_store, iter_labeled_windows, iter_aligned_windows.
  • Filters - OneEuroFilter, GaussianFilter, IdentityFilter.

For a quick lookup without prose, see the API cheatsheet.