Skip to content

[DOC] Add docstrings for best_estimator.py#235

Open
omkar-334 wants to merge 1 commit intohyperactive-project:mainfrom
omkar-334:estimator-docs
Open

[DOC] Add docstrings for best_estimator.py#235
omkar-334 wants to merge 1 commit intohyperactive-project:mainfrom
omkar-334:estimator-docs

Conversation

@omkar-334
Copy link

Description

This PR adds docstrings for best_estimator.py, from https://github.com/scikit-learn/scikit-learn/blob/main/sklearn/model_selection/_search.py

Related Issues

Fixes #226

Type of Change

  • [BUG] - Bug fix (non-breaking change fixing an issue)
  • [ENH] - New feature (non-breaking change adding functionality)
  • [DOC] - Documentation changes
  • [MNT] - Maintenance

How was this solved?

Checklist

  • PR title includes appropriate tag: [BUG], [ENH], [DOC] or [MNT]
  • Linked to related issue (if applicable)
  • Code passes make check (lint, format, isort)

Note

@SimonBlanke make check is failing because of unused imports, unorganized imports and other issues... Can I take that up too?

Found 90 errors.
[*] 67 fixable with the `--fix` option (1 hidden fix can be enabled with the `--unsafe-fixes` option).
make: *** [lint] Error 1

Only available if ``refit=True`` and the underlying estimator supports
``score_samples``.

.. versionadded:: 0.24
Copy link
Collaborator

Choose a reason for hiding this comment

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

what is that?

X : indexable, length n_samples
Must fulfill the input assumptions of the
underlying estimator.

Copy link
Collaborator

Choose a reason for hiding this comment

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

'Xt' is not documented here.

Returns
-------
y_score : ndarray of shape (n_samples,)
The ``best_estimator_.score_samples`` method.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should be more detailed.

@SimonBlanke
Copy link
Collaborator

make check is failing because of unused imports, unorganized imports and other issues... Can I take that up too?

@omkar-334 I would suggest you run it locally and look into the errors and understand them. If they are relevant or something should be changed you should open an issue for it 👍

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.

[DOC] Enhance BestEstimator docstrings

2 participants

Comments