Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Docstring of 'tol' #94

Open
mscheltienne opened this issue Nov 4, 2022 · 0 comments
Open

[DOC] Docstring of 'tol' #94

mscheltienne opened this issue Nov 4, 2022 · 0 comments
Labels
📓 doc Improvements or additions to documentation

Comments

@mscheltienne
Copy link
Collaborator

Spotted this remaining TODO item:

tol : float
Relative tolerance with regards estimate residual noise in the cluster
centers of two consecutive iterations to declare convergence.
%(random_state)s
References
----------
.. footbibliography::
"""
# TODO: docstring for tol doesn't look english

Maybe:

Convergence criterium: relative tolerance with regard to the estimated 
residual noise in the cluster centers of two consecutive iterations.

cc @vferat

@mscheltienne mscheltienne added the 📓 doc Improvements or additions to documentation label Nov 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📓 doc Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant