What's Changed

• Bugfix/update workflow by @arvkevi in #147
• Attempt to fix CI by @arvkevi in #163
• Workflow permissions by @arvkevi in #165
• Fix knee detection to pause after local minima per Kneedle algorithm specification by @Copilot in #166
• Update docs by @arvkevi in #167
• Update version by @arvkevi in #168

New Contributors

• @Copilot made their first contribution in #166

Full Changelog: v0.8.5...v0.8.6

What's Changed

• Remove all warnings when no knees are found by @arvkevi in #156

Full Changelog: v0.8.4...v0.8.5

What's Changed

• Update rtd by @arvkevi in #152
• No longer warns when no knee/elbow is found by @arvkevi in #153

Full Changelog: v0.8.3...v0.8.4

What's Changed

• Test Python 3.11 during GH Actions by @arvkevi in #140
• Updating references to the old default branch name by @arvkevi in #141
• Fix ci by @arvkevi in #143
• remove MANIFEST file, it is not used with hatch by @m-birke in #144
• Fix index error in online knee finding by @Shotgunosine in #145
• Bump version by @arvkevi in #146

New Contributors

• @m-birke made their first contribution in #144
• @Shotgunosine made their first contribution in #145

Full Changelog: v0.8.2...v0.8.3

@ofek This was a breeze. Thanks for the great work on Hatch!

What's Changed

• Fix typo in online parameter docs by @arvkevi in #130
• Update docstring to clarify x and y inputs as 1D arrays or lists. by @arvkevi in #132
• Update codecov action by @arvkevi in #135
• Hacky way to test no matplotlib by @arvkevi in #136
• Added variables for visualization title and labels by @Janson-L in #134
• Hatch is working by @arvkevi in #138
• Bump version by @arvkevi in #139

New Contributors

• @Janson-L made their first contribution in #134

Full Changelog: v0.8.1...v0.8.2

This fixes the kneed/__init__.py issue reading the VERSION file.

The most relevant change in this release is that matplotlib is now an optional dependency. Two convenience plotting functions in the KneeLocator class use matplotlib. After 0.8.0, users will need to install using the following command to get plotting functionality: pip install kneed[plot].
Thanks for contributing this feature @samhanic!

Additional functionality was added by @zhongminhu to detect the shape of the curve. This is helpful if you need to know which values to use for the direction and curve arguments of the KneeLocator class.

from kneed.shape_detector import find_shape
direction, curve = find_shape(x, y)

Other changes include quality of life improvements for maintaining the package that should not affect the user.

This release has various improvements, including:

• added codecov for calculating code coverage
• use pytest-cov
• increased test coverage to 100%
• warn on flat curve
• kneed now validates arguments for curve and direction
• refactored the algorithm
• remove scikit-learn dependency and switch to numpy polyfit.
• documentation!!!

• add support for accessing the y value of the knee point.

Thank you to @tommilligan for identifying and fixing the bug.

same source code as v0.5.2