Skip to content

DOC improve docstring in OPTICS functions compute_optics_graph #22024

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Jan 24, 2022
Merged

DOC improve docstring in OPTICS functions compute_optics_graph #22024

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dcee936
Fixed numpydoc sklearn.cluster._optics.cluster_optics_xi
moonkyung-kang Dec 20, 2021
8c0b903
Fixed numpydoc sklearn.cluster._optics.compute_optics_graph
moonkyung-kang Dec 20, 2021
b3996b3
address reviews
glemaitre Jan 24, 2022
5442e8d
iter
glemaitre Jan 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions sklearn/cluster/_optics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ class OPTICS(ClusterMixin, BaseEstimator):
should take two arrays as input and return one value indicating the
distance between them. This works for Scipy's metrics, but is less
efficient than passing the metric name as a string. If metric is
"precomputed", X is assumed to be a distance matrix and must be square.
"precomputed", `X` is assumed to be a distance matrix and must be
square.

Valid values for metric are:

Expand Down Expand Up @@ -124,11 +125,11 @@ class OPTICS(ClusterMixin, BaseEstimator):
algorithm : {'auto', 'ball_tree', 'kd_tree', 'brute'}, default='auto'
Algorithm used to compute the nearest neighbors:

- 'ball_tree' will use :class:`BallTree`
- 'kd_tree' will use :class:`KDTree`
- 'ball_tree' will use :class:`BallTree`.
- 'kd_tree' will use :class:`KDTree`.
- 'brute' will use a brute-force search.
- 'auto' will attempt to decide the most appropriate algorithm
based on the values passed to :meth:`fit` method. (default)
- 'auto' (default) will attempt to decide the most appropriate
algorithm based on the values passed to :meth:`fit` method.

Note: fitting on sparse input will override the setting of
this parameter, using brute force.
Expand Down Expand Up @@ -457,8 +458,8 @@ def compute_optics_graph(
algorithm : {'auto', 'ball_tree', 'kd_tree', 'brute'}, default='auto'
Algorithm used to compute the nearest neighbors:

- 'ball_tree' will use :class:`BallTree`
- 'kd_tree' will use :class:`KDTree`
- 'ball_tree' will use :class:`BallTree`.
- 'kd_tree' will use :class:`KDTree`.
- 'brute' will use a brute-force search.
- 'auto' will attempt to decide the most appropriate algorithm
based on the values passed to :meth:`fit` method. (default)
Expand Down