You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Your kneedle algorithm implementation work pretty good for me, thank you very much!
Just one minor issue: The package itself lacks of some documentation. What I have been looking for:
General documentation for "kneed" module, unfortunately there is no docstring for the "kneed" package once imported: Docstring: <no docstring>
I am missing here a full documentation for the functions and methods provided just by looking into the module's offline documentation
Finding the "best" sensitivity parameter is documented here, but I think the statement "S is a measure of how many “flat” points we expect to see in the unmodified data curve before declaring a knee." needs to be represented in the docstring for kneed.KneeLocator() as well. Currently it's just :ivar S: Sensitivity, original paper suggests default of 1.0
In my honest opinion, the parameters information in the docstring currently is a little confusing to be honest. I think it would be good if parameter names, descriptions and accepted data types could be cleaned up a little to a more easier-to-read format just like docstrings in numpy or pandas. For example:
:param S: Sensitivity, original paper suggests default of 1.0
:type S: float
to
Parameters
----------
S : float
Sensitivity, original paper suggests default of 1.0
Kind regards,
DK
The text was updated successfully, but these errors were encountered:
Your kneedle algorithm implementation work pretty good for me, thank you very much!
Just one minor issue: The package itself lacks of some documentation. What I have been looking for:
General documentation for "kneed" module, unfortunately there is no docstring for the "kneed" package once imported:
Docstring: <no docstring>
I am missing here a full documentation for the functions and methods provided just by looking into the module's offline documentation
Finding the "best" sensitivity parameter is documented here, but I think the statement "S is a measure of how many “flat” points we expect to see in the unmodified data curve before declaring a knee." needs to be represented in the docstring for
kneed.KneeLocator()
as well. Currently it's just:ivar S: Sensitivity, original paper suggests default of 1.0
In my honest opinion, the parameters information in the docstring currently is a little confusing to be honest. I think it would be good if parameter names, descriptions and accepted data types could be cleaned up a little to a more easier-to-read format just like docstrings in
numpy
orpandas
. For example:to
Kind regards,
DK
The text was updated successfully, but these errors were encountered: