Breakout detection for Python
Project description
Breakout Python
:fire: BreakoutDetection for Python
Learn how it works
Installation
Run:
pip install breakout-detection
Getting Started
Detect breakouts in a time series
from breakout import breakout
series = [100, 150, 136, ...]
breakout(series)
Options
Pass options - default values below
breakout(
series,
min_size=30, # minimum observations between breakouts
method='multi', # multi or amoc (at most one change)
degree=1, # degree of the penalization polynomial (multi only)
beta=0.008, # penalization term (multi only)
percent=None, # minimum percent change in goodness of fit statistic (multi only)
alpha=2, # weight of the distance between observations (amoc only)
exact=True # exact or approximate median (amoc only)
)
Credits
This library uses the C++ code from the BreakoutDetection R package and is available under the same license.
References
History
View the changelog
Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- Report bugs
- Fix bugs and submit pull requests
- Write, clarify, or fix documentation
- Suggest or add new features
To get started with development:
git clone https://github.com/ankane/breakout-python.git
cd breakout-python
pip install -r requirements.txt
python setup.py install
pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
breakout_detection-0.2.0.tar.gz
(15.3 kB
view hashes)