[scikit-learn/scikit-learn] 896a76: [MRG][DOC] Fix inconsistencies in clustering doc. ...

Branch: refs/heads/master Home: https://github.com/scikit-learn/scikit-learn Commit: 896a76eb22fe498494ab1b73594a13a7f266b912 https://github.com/scikit-learn/scikit-learn/commit/896a76eb22fe498494ab1b73... Author: Anaël Beaugnon <anael.beaugnon@ssi.gouv.fr> Date: 2019-05-30 (Thu, 30 May 2019) Changed paths: M sklearn/cluster/affinity_propagation_.py M sklearn/cluster/dbscan_.py M sklearn/cluster/hierarchical.py M sklearn/cluster/spectral.py Log Message: ----------- [MRG][DOC] Fix inconsistencies in clustering doc. (#13946) * Fix inconsistencies in clustering doc. This commit concerns only the clustering algorithms that can take as input affinity or distance matrices. * fit and fit_predict have now the same descriptions for their input arguments X and y. * The commit follows the documentation conventions detailed in issue #3791. * Precise the preferred sparse matrix format if relevant. * AgglomerativeClustering. The documentation of the fit method now clarifies that a distance matrix is expected (not an affinity / similarity matrix). The parameter affinity is misleading (see issue #13945). * Answer partly to issue #13945. Only the documentation is updated. Updating the name of the ̀ affinity` parameter would involve an API change, with a proper deprecation cycle. * Wrong arguments for fit_predict of AffinityPropag. No argument sample_weight. * Wrong arguments for fit_predict of AgglomerativeCl No argument sample_weight. * Add a comma (review by jnohman) Co-Authored-By: Joel Nothman <joel.nothman@gmail.com> * Rm modification (review by jnothman) * Add commas. * Update sklearn/cluster/affinity_propagation_.py Co-Authored-By: Joel Nothman <joel.nothman@gmail.com> * Fix back quotes (review by jnothman) * add commas * fit_predict and predict return labels. Description: "Cluster labels." * Doc fit: returns "self". * Same modifications for SpectralClustering.
participants (1)
-
Anaël Beaugnon