Skip to content

DOC Ensures that get_chunk_n_rows passes numpydoc validation #22539

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 1 commit into from
Feb 18, 2022
Merged

DOC Ensures that get_chunk_n_rows passes numpydoc validation #22539

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion sklearn/tests/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,6 @@
"sklearn.utils.fixes.threadpool_limits",
"sklearn.utils.gen_batches",
"sklearn.utils.gen_even_slices",
"sklearn.utils.get_chunk_n_rows",
"sklearn.utils.graph.graph_shortest_path",
"sklearn.utils.graph.single_source_shortest_path_length",
"sklearn.utils.is_scalar_nan",
Expand Down
11 changes: 6 additions & 5 deletions sklearn/utils/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -941,7 +941,7 @@ def _print_elapsed_time(source, message=None):


def get_chunk_n_rows(row_bytes, *, max_n_rows=None, working_memory=None):
"""Calculates how many rows can be processed within working_memory.
"""Calculate how many rows can be processed within `working_memory`.

Parameters
----------
Expand All @@ -951,17 +951,18 @@ def get_chunk_n_rows(row_bytes, *, max_n_rows=None, working_memory=None):
max_n_rows : int, default=None
The maximum return value.
working_memory : int or float, default=None
The number of rows to fit inside this number of MiB will be returned.
When None (default), the value of
The number of rows to fit inside this number of MiB will be
returned. When None (default), the value of
``sklearn.get_config()['working_memory']`` is used.

Returns
-------
int or the value of n_samples
int
The number of rows which can be processed within `working_memory`.

Warns
-----
Issues a UserWarning if ``row_bytes`` exceeds ``working_memory`` MiB.
Issues a UserWarning if `row_bytes exceeds `working_memory` MiB.
"""

if working_memory is None:
Expand Down