[DOC] Enhance BestEstimator docstrings (Fixes #226) #230
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR improves the documentation for the
BestEstimatorclass by replacing minimal docstrings with detailed NumPy-style documentation. It adds parameter descriptions, return types, and clear explanations for key methods.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]- MaintenanceHow was this solved?
I updated the docstrings for the following methods in
src/hyperactive/integrations/sklearn/best_estimator.py:score_samples,predict,predict_proba,predict_log_probadecision_function,transform,inverse_transformclasses_propertyFor each method, I added:
X(array-like) and its shape._deprecate_xt_in_inverse_transformare imported and used with the correct capitalization.Checklist
[BUG],[ENH],[DOC]or[MNT]make check(lint, format, isort)Testing
Since this is a documentation-only change, no new tests were required.
I verified the syntax validity locally using:
python -m compileall src/hyperactive/integrations/sklearn/best_estimator.pyAdditional Notes
Ensured indentation aligns with the project's existing code style.