Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC Add interval notation for include_boundaries in documentation check_scalar #21955

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 9 commits into from
Dec 17, 2021
Merged

DOC Add interval notation for include_boundaries in documentation check_scalar #21955

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1ba3134
add interval notation in check_scalar doc
yadav-sachin Dec 11, 2021
581db61
Merge remote-tracking branch 'upstream/main' into interval_notation
yadav-sachin Dec 11, 2021
5218983
restore sentence descriptions
yadav-sachin Dec 14, 2021
d6a4d64
Merge remote-tracking branch 'upstream/main' into interval_notation
yadav-sachin Dec 14, 2021
535077a
correct interval notations
yadav-sachin Dec 14, 2021
db49abc
remove backticks in intervals
yadav-sachin Dec 14, 2021
5658c29
correct formatting
yadav-sachin Dec 14, 2021
aff8fea
elaborate interval notations
yadav-sachin Dec 15, 2021
e603adb
replace semicolons with full stops
yadav-sachin Dec 17, 2021
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
11 changes: 7 additions & 4 deletions sklearn/utils/validation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1385,11 +1385,14 @@ def check_scalar(
Whether the interval defined by `min_val` and `max_val` should include
the boundaries. Possible choices are:

- `"left"`: only `min_val` is included in the valid interval;
- `"right"`: only `max_val` is included in the valid interval;
- `"both"`: `min_val` and `max_val` are included in the valid interval;
- `"left"`: only `min_val` is included in the valid interval.
It is equivalent to the interval `[ min_val, max_val )`.
- `"right"`: only `max_val` is included in the valid interval.
It is equivalent to the interval `( min_val, max_val ]`.
- `"both"`: `min_val` and `max_val` are included in the valid interval.
It is equivalent to the interval `[ min_val, max_val ]`.
- `"neither"`: neither `min_val` nor `max_val` are included in the
valid interval.
valid interval. It is equivalent to the interval `( min_val, max_val )`.

Returns
-------
Expand Down