Add abstract base class for SignalModel #132
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tab-cmd
approved these changes
Apr 19, 2021
There was a problem hiding this comment.
Awesome to see this! Thanks, Niklas! 😄 Let's add some information about creating new models using the base class to the README.md. https://github.com/CAMBI-tech/BciPy/tree/main/bcipy/signal
lawhead
approved these changes
Apr 19, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Added an abstract base class
SignalModelin preparation for refactoring the current PCA/RDA/KDE model and then integrating a new neural network model.Ticket
https://www.pivotaltracker.com/story/show/177691543
Contributions
bcipy/signal/model/model.py- Add abstract base classbcipy/signal/model/__init__.py- Make abstract base class available usingfrom bcipy.signal.model import SignalModelTest
No tests added for this abstract class.
Documentation
The base class has simple descriptions of the purpose of each method. Once the PCA/RDA/KDE model is refactored to this structure, more documentation can be added if useful. Alternatively, a "dummy" example class could be added if that would be useful.