8000 DOC Improve OPTICS doc by qinhanmin2014 · Pull Request #13866 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]

Skip to content

DOC Improve OPTICS doc #13866

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

Merged
merged 2 commits into from
May 15, 2019
Merged

DOC Improve OPTICS doc #13866

merged 2 commits into from
May 15, 2019

Conversation

qinhanmin2014
Copy link
Member

(1) More notes about the difference between our implementation and the original paper
(2) We support metric='precomputed' (tested in test_precomputed_dists)
(3) Update the description of max_eps to keep consistent with DBSCAN (see #13563)
ping @jnothman @adrinjalali

Copy link
Member
@jnothman jnothman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise LGTM

X : array, shape (n_samples, n_features)
The data.
X : array, shape (n_samples, n_features), or (n_samples, n_samples) \
if metric=’precomputed’.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer this indented... I don't see any reason to have it flush left.

Suggested change
if metric=precomputed’.
if metric=precomputed’.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #5078, we do similar things in some latest classes, e.g., ColumnTransformer

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I had time to pull this into an ancient discussion of this at numpydoc, I would... Thanks

X : array, shape (n_samples, n_features)
The data.
X : array, shape (n_samples, n_features), or (n_samples, n_samples) \
if metric=’precomputed’.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if metric=precomputed’.
if metric=precomputed’.

Co-Authored-By: Joel Nothman <joel.nothman@gmail.com>
@jnothman jnothman merged commit fb8721a into scikit-learn:master May 15, 2019
@jnothman
Copy link
Member

Thanks

jnothman pushed a commit that referenced this pull request May 15, 2019
@qinhanmin2014 qinhanmin2014 deleted the optics-doc branch July 5, 2019 13:18
koenvandevelde pushed a commit to koenvandevelde/scikit-learn that referenced this pull request Jul 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0