TODO.md

Things That Need Doing

Big Changes

• Migrate models to separate library/repository.
• Allow for automated model installation.
• Host latest version of peak_finder on Pypi again.

Docstrings

The following files still need to be written with scikit docstring format. They generally have something written for most if not all functions/classes/methods. But, the documentation is still incomplete.

• automatic.py
• classify_data.py
• data_spy.py
• efficient_data_generation.py
• fit_lorentz.py
• generate_data.py
• generate_lorentz.py
• live_fitting.py
  • Common functions
  • _Selection
  • _Live_Instance
  • _Color_Selector
  • _Point_Selector
  • _Mistake_Selector
  • live_selection
  • color_selection
  • point_selection
  • mistake_selection
• models.py
• sliding_window.py
• train_model.py
• utilities.py
• scripts/train_simple_class.py
• scripts/train_tight_wiggle.py
• scripts/train_wide_wiggle.py

Bug Fixes

The following scripts don't respond well to running in the main PATH. They instead need to be run from their default directory. Also, their connection to the model they train from needs to be updated.

• scripts/train_simple_count.py
• scripts/train_tight_wiggle.py
• scripts/train_wide_wiggle.py

And these ones need to be fixed or removed.

• scripts/multi_class_train.py
• scripts/train_simple_count.py

Other Stuff

• Write guide on training models.
• Rewrite peak tracker.
• Update this todo list because it's so out of date lol 🙁

Tests.

• Write tests for everything. 🙁
• Add tooltips to live sessions.