Skip to content
Praveen Kumar edited this page Jul 19, 2026 · 3 revisions

FAQ

Does CleanFrame need an API key?

No. Rules-only mode is the default and is fully offline.

Does the LLM see my data?

Not in the default metadata exposure. It sees column names, types, stats, and pattern sketches. Opt into llm_exposure="sample" only when you accept sending an anonymized sample.

Why didn't it fill my missing values?

By design. Missingness is reported; fill_na is never auto-proposed. Add it to the recipe yourself if imputation is appropriate.

Why did a recipe column get skipped?

The source column was missing from the frame. Non-strict modes warn and continue; strict raises. Prefer suggest_update / re-plan when schema drifts.

Can I use this in Airflow / Prefect / CI?

Yes — commit the recipe YAML and call apply_recipe (or the CLI apply subcommand) in the task. Fail the run on DriftError.

How do I handle Excel?

pip install "cleanframe[excel]"

How do I handle Parquet?

pip install "cleanframe[parquet]"

How do I clean an Excel file with multiple sheets?

Multi-sheet workbooks now raise if no sheet is chosen. Use cf.clean_workbook(path) or cleanframe clean file.xlsx to clean every tab (one recipe + diff per sheet), or pass sheet= to pick one.

Can it handle files bigger than memory?

Yes — cf.stream_apply(recipe, in_path, out_path, chunksize=N) (CLI apply FILE --recipe R --chunksize N) replays row-independent recipes out-of-core. Global ops (dedup, fill_na mean/median/…) are refused; peak memory is bounded by the chunk size, not file size.

It read my CSV as one column / wrong encoding?

Read-time format auto-correction detects the delimiter and encoding by default and pins them into the recipe. Pass --no-correct (correct_format=False) to disable; an ambiguous delimiter raises rather than guessing.

Is the HTML report XSS-safe?

Yes — Jinja2 autoescape is on; covered by tests.

Will cast: int truncate money?

cast to int rounds floats (pandas nullable Int64). Prefer keeping amounts as float, or round explicitly with the round op first.

Where is the wiki?

GitHub Wiki — sources live in wiki/ in this repository.

Clone this wiki locally