Skip to content

docs: show the output estimates on a fitted preprocessor - #144

Open
xillig wants to merge 1 commit into
OpenTabular:mainfrom
xillig:docs/output-budget-estimates
Open

xillig wants to merge 1 commit into
OpenTabular:mainfrom
xillig:docs/output-budget-estimates

Conversation

@xillig

@xillig xillig commented Nov 11, 2026

Copy link
Copy Markdown

Summary

The output-budget example in docs/core_concepts/outputs_and_inspection.md called estimate_output_shape() / estimate_memory() on an unfitted Preprocessor, which raises NotFittedError, and the page advised running them before a fit that overflow_policy="error" would reject. Both are fitted methods.

The example now fits first, and the page explains how to size a large dataset up front: fit on a sample (the row count is read from the data passed to the estimate) or fit with overflow_policy="warn". The new snippets were executed as written. Docs-only change.

Validation

Checks: full suite (2544 passed, 59 skipped, 7 xfailed, coverage >= 94.79%), ruff format / ruff check, pyright (no new diagnostics), docs build with -W, scripts/quickstart.py. Merges cleanly with main and with #136.

The output-budget example called estimate_output_shape() and
estimate_memory() on an unfitted Preprocessor, which raises
NotFittedError, and the page advised running them before a fit that
overflow_policy="error" would reject. Both are fitted methods: the
output width is only known after fit.

The example now fits first, and the page explains how to size a large
dataset up front: fit on a sample (the row count is read from the data
passed to the estimate), or fit with overflow_policy="warn".

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant