Skip to content

Commit

Permalink
Clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
arvkevi committed Jul 9, 2023
1 parent 49e6563 commit 2137403
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 7 deletions.
7 changes: 4 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ Welcome to kneed's documentation!

This is the documentation for the `kneed <https://github.com/arvkevi/kneed>`__ Python package.
Given `x` and `y` arrays, `kneed` attempts to identify the knee/elbow point of a line fit to the data.
The knee/elbow is defined as the point of the line with maximum curvature. For more information about how each of
the parameters affect identification of knee points, check out :ref:`parameters`. For a full reference of the API,
head over to the :ref:`api`.
The knee/elbow is defined as the point of the line with maximum curvature.

For more information about how each of the parameters affect identification of knee points, check out :ref:`parameters`.
For a full reference of the API, head over to the :ref:`api`.

.. toctree::
parameters
Expand Down
4 changes: 1 addition & 3 deletions docs/interactive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@ Interactive Streamlit App
=========================

An interactive streamlit app was developed to help users explore the effect of tuning the parameters.
There are two sites where you can test out kneed by copy-pasting your own data:

1. https://share.streamlit.io/arvkevi/ikneed/main/ikneed.py
2. https://ikneed.herokuapp.com/
https://share.streamlit.io/arvkevi/ikneed/main/ikneed.py

You can also run your own version -- head over to the source code for ikneed_.

Expand Down
2 changes: 1 addition & 1 deletion kneed/knee_locator.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ class KneeLocator(object):
:vartype all_elbows: set
:ivar all_norm_elbows: The normalized x values of all the identified knee points (elbow and knee are interchangeable).
:vartype all_norm_elbows: set
:ivar all_norm_elbowss_y: The normalized y values of all the identified knee points (elbow and knee are interchangeable).
:ivar all_norm_elbows_y: The normalized y values of all the identified knee points (elbow and knee are interchangeable).
:vartype all_norm_elbows: set
"""

Expand Down

0 comments on commit 2137403

Please sign in to comment.