vferat/pycrostates

[DOC] Docstring of 'tol'

Opened this issue · 0 comments

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