Skip to content

Document num_sample=None in natural_breaks docstring #3505

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
brendancol merged 2 commits into from
Jun 26, 2026
Merged

Document num_sample=None in natural_breaks docstring #3505

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6281651
Document num_sample=None in natural_breaks docstring (#3501)
brendancol Jun 25, 2026
ff9b8c4
Reword natural_breaks num_sample=None note to fit the Jenks path
brendancol Jun 25, 2026
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
7 changes: 6 additions & 1 deletion xrspatial/classify.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -842,12 +842,17 @@ def natural_breaks(agg: xr.DataArray,
of values to be reclassified.
k : int, default=5
Number of classes to be produced.
num_sample : int, default=20000
num_sample : int or None, default=20000
Number of sample data points used to fit the model.
Natural Breaks (Jenks) classification is indeed O(n²) complexity,
where n is the total number of data points, i.e: `agg.size`
When n is large, we should fit the model on a small sub-sample
of the data instead of using the whole dataset.
``None`` means fit on all data instead of a sub-sample. That is
the full O(n²) case described above, so it may be slow and raises
``MemoryError`` if the Jenks matrices would exceed half of the
available RAM. For dask the full sample is drawn lazily via
indexed access.
name : str, default='natural_breaks'
Name of output aggregate.

Expand Down
Loading