Skip to content

Document dask backend laziness guarantees per function#1165

Merged
brendancol merged 1 commit intomasterfrom
issue-1164
Apr 5, 2026
Merged

Document dask backend laziness guarantees per function#1165
brendancol merged 1 commit intomasterfrom
issue-1164

Conversation

@brendancol
Copy link
Copy Markdown
Contributor

@brendancol brendancol commented Apr 5, 2026

Summary

  • Adds a "Dask backend behavior" reference page documenting every public function's laziness level (fully lazy / partially lazy / fully materialized)
  • 22 regression tests that assert dask-backed outputs remain lazy where expected, using dask.is_dask_collection() checks
  • Covers terrain metrics, focal ops, classification, and normalization

Closes #1164

Test plan

  • pytest xrspatial/tests/test_dask_laziness.py -- 22/22 passing
  • Verify docs build: cd docs && make html
  • Spot-check the rendered dask_laziness.rst tables look correct

@brendancol
Add dask laziness docs and regression tests (#1164)
2848811 
Reference page listing every public function's dask laziness level
(fully lazy / partially lazy / fully materialized) so users can plan
pipelines without reading source.  22 tests assert that functions
expected to stay lazy actually return dask collections.
@github-actions github-actions bot added the performance PR touches performance-sensitive code label Apr 5, 2026
@brendancol brendancol merged commit 29556ed into master Apr 5, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

performance PR touches performance-sensitive code

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document dask backend laziness guarantees per function

1 participant

@brendancol