Skip to content

docs(cookbook): add missing values strategy and imputation cookbook guide #513

Closed

Description

@JohnnyWilson16

Context

As identified in the Growth & Developer Onboarding Audit, developers searching for practical solutions like "how to handle missing values pandas" or "safe tabular imputation" benefit from problem-oriented cookbook recipes in docs/cookbook/.

Task

Create a new problem-oriented cookbook guide in docs/cookbook/imputation-strategies-guide.md illustrating how FreshData approaches missing value imputation safely:

  1. Explain the difference between simple univariate imputation (mean, median, mode) vs iterative model-based imputation (missforest).
  2. Show how to configure per-column imputation rules vs global strategy.
  3. Demonstrate FreshData's safety guarantees (e.g. refusal to impute declared ID or target columns).
  4. Show how to inspect the generated CleanReport audit log to see exactly which rows and columns were modified.
  5. Register the new recipe under the Cookbook section in mkdocs.yml.

Acceptance Criteria

  • Create docs/cookbook/imputation-strategies-guide.md with complete markdown explanations and runnable Python examples.
  • Document parameter combinations (strategy="conservative" vs "balanced" vs "aggressive", impute=...).
  • Add the page to the nav list in mkdocs.yml under Cookbook.
  • Verify that documentation builds cleanly without broken links using mkdocs build --strict.

Pointers


New to the codebase? Comment /assign to claim this issue! You can also check our First Contribution Guide.

Activity

  1. removed their assignment
    on Oct 1, 2026
  2. WilliamK112 commented on Oct 13, 2026

    @WilliamK112
    Contributor

    /assign

    I’m preparing the requested imputation-strategies cookbook with executed examples for global/per-column rules, declared ID and target protection, MissForest model/fallback behavior, and audit inspection. I’ll document the current report granularity accurately and verify the strict docs build.

  3. github-actions commented on Oct 13, 2026

    @github-actions

    Hey @WilliamK112! 🎉 You have claimed this issue.

    Quick Onboarding Checklist

    • 📖 Read the First Contribution Guide.
    • ⚡ Fast local test iteration: pytest tests/<test_file>.py --no-cov (bypasses CI 93% global gate during local development).
    • 🔍 Lint & style checks: ruff check .
    • 💬 If you have questions or need clarification, ask anytime here in the comments!

    (Need to unassign yourself? Simply reply with /unassign.)

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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomersin-progressAn open issue currently being worked on

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions