Skip to content

Docs: README usage example and examples/ quickstart notebook (#7) - #16

Open
mertcankaratass wants to merge 1 commit into
octacity-org:mainfrom
mertcankaratass:docs/quickstart-notebook
Open

mertcankaratass wants to merge 1 commit into
octacity-org:mainfrom
mertcankaratass:docs/quickstart-notebook

Conversation

@mertcankaratass

Copy link
Copy Markdown

Closes #7

Summary

Adds a runnable quick start example to the README and an end-to-end interactive tutorial notebook in examples/quickstart.ipynb.

  • README quick start: replaced the planned API note with a runnable inline DataFrame example showing it_transform on train, ransform on test, and get_feature_names_out(). The printed output matches code execution exactly.
  • examples/quickstart.ipynb:
    • Generates a self-contained synthetic customer classification dataset (runs completely offline without downloads).
    • Demonstrates each block individually (MissingValueImputer, CategoricalEncoder, FeatureScaler), then composes them in Pipeline.
    • Shows feature names tracking after one-hot encoding with get_feature_names_out().
    • Integrates with scikit-learn via make_pipeline and cross_val_score(cv=5).
    • Explains and demonstrates data leakage prevention by comparing training center with test set statistics.
    • Executed and committed with outputs.
  • pyproject.toml: added jupyter and
    bconvert to dev extra.

How was it tested

  • pytest: 137 passed in 2.00s
  • jupyter nbconvert --to notebook --execute examples/quickstart.ipynb: runs cleanly with exit code 0

uff check .: All checks passed!

uff format --check .: 15 files already formatted

Checklist

  • [x]
    uff format . and
    uff check . pass
  • pytest passes
  • New or changed blocks follow the block rules in CONTRIBUTING.md
  • Block tests include a leakage test (statistics come from the training data only) and a run inside sklearn cross_val_score

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.

README usage example and examples/ quickstart notebook

1 participant