Skip to content

docs(examples): add feature tutorials and domain pipeline notebooks#72

Merged
nxank4 merged 15 commits intomainfrom
docs/example-notebooks
Feb 27, 2026
Merged

docs(examples): add feature tutorials and domain pipeline notebooks#72
nxank4 merged 15 commits intomainfrom
docs/example-notebooks

Conversation

@nxank4
Copy link
Copy Markdown
Collaborator

@nxank4 nxank4 commented Feb 27, 2026

Summary

Adds 7 new example notebooks covering all Loclean features added since v0.1, plus a comprehensive README update.

Focused Feature Tutorials (06-10)

Each notebook demonstrates one API with beginner-friendly data and clear explanations:

# Notebook API
06 Entity Resolution loclean.resolve_entities()
07 Semantic Oversampling loclean.oversample()
08 Log Shredding loclean.shred_to_relations()
09 Feature Discovery loclean.discover_features()
10 Quality Validation loclean.validate_quality()

Domain Pipeline Notebooks (11-12)

Two realistic end-to-end pipelines that combine multiple features:

# Notebook Domain APIs Used
11 🏠 Kaggle Housing Pipeline Data Science clean → resolve → discover → oversample → validate → scrub
12 🔧 Log Engineering Pipeline Data Engineering extract → compiled-extract → shred → resolve → validate → scrub

Audit Decisions

  • Dropped the generic end-to-end pipeline (was chore/fix ruff linting #11) — it was a strict subset of the Kaggle housing pipeline with fewer features and less educational value
  • No overlap between 06-10: each covers exactly one API
  • Renumbered 12→11, 13→12 for contiguous numbering
  • Stripped all outputs for clean diffs and reproducibility
  • Fixed zip() calls to use strict=True (B905)
  • Fixed variable shadowing (scrubmasked in loop vars)

README Updates

Updated the Available Notebooks section to reflect the new numbering and removed the dropped notebook entry.

…eAuditor

- TrapPruner: statistical profiling + LLM verification of Gaussian noise columns
- MissingnessRecognizer: MNAR pattern detection with sandbox-compiled encoders
- TargetLeakageAuditor: semantic timeline evaluation for target leakage
…o public API

- Add all three to extraction/__init__.py lazy imports
- Add Loclean class methods + module-level convenience functions
- Update __all__ in loclean/__init__.py
…r, TargetLeakageAuditor

- 13 tests each (39 total) covering profiling, prompt construction,
  verdict parsing, verification, and mock-LLM integration
- Strip markdown fences, prose, and backticks
- Fix unicode operators and invalid numeric literals
- 17 unit tests covering all transformation stages
- LLM-generated import statements now only work for explicitly
  allowed modules; all others raise ImportError
- Preload modules into safe_globals for direct namespace access
- Updated docstring to document the restriction
- Wrap initial compile in try/except to catch ValueErrors
- Add per-retry logging with attempt counter
- Replace vague failure messages with actionable guidance
  (model suggestions, max_retries hint)
- Add concrete code examples to LLM prompts for better output
- Add module-level _verified_models set for deduplication
- Fix model_exists to handle both dict and object API responses
- Use model attribute (not name) for correct Ollama registry matching
Superseded by examples/README.md and module docstrings.
- 06-entity-resolution: canonicalize messy string variations
- 07-oversampling: Pydantic-schema-driven minority-class augmentation
- 08-log-shredding: parse unstructured logs into relational tables
- 09-feature-discovery: LLM-proposed feature engineering
- 10-quality-validation: plain-English rule evaluation
- 11-kaggle-housing-pipeline: full data-science workflow
  (clean → resolve → discover → oversample → validate → scrub)
- 12-log-engineering-pipeline: full data-engineering workflow
  (extract → compiled-extract → shred → resolve → validate → scrub)

Removed redundant generic end-to-end notebook (subsumed by these
domain-specific pipelines).
- Remove entry for deleted generic end-to-end pipeline (11)
- Renumber Kaggle housing to 11, log engineering to 12
… optimizer

- 13-trap-pruning: detect and remove Gaussian noise columns
- 14-missingness-recognition: MNAR pattern detection with boolean flags
- 15-leakage-auditing: semantic timeline evaluation for leakage
- 16-instruction-optimization: reward-driven prompt refinement
- Break long f-string in 06-entity-resolution
- Split log entry string literals in 12-log-engineering-pipeline
- Extract variables in quality gate print statements
@nxank4 nxank4 merged commit b855800 into main Feb 27, 2026
21 checks passed
@nxank4 nxank4 deleted the docs/example-notebooks branch February 27, 2026 18:41
@devactivity-app
Copy link
Copy Markdown

Pull Request Summary by devActivity

Metrics

Cycle Time: 3d 14h 49m Coding Time: 3d 14h 48m

Achievements

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