🚀 Quick Start Guide: KDP in 5 Minutes

Get your tabular data ML-ready in record time!

This guide will have you transforming raw data into powerful features before your coffee gets cold.

🏁 The KDP Experience in 3 Steps

Define Your Features

from kdp import PreprocessingModel, FeatureType

# Quick feature definition - KDP handles the complexity
features = {
    # Numerical features with smart preprocessing
    "age": FeatureType.FLOAT_NORMALIZED,          # zero mean, unit variance
    "income": FeatureType.FLOAT_NORMALIZED,       # standardised too

    # Categorical features with automatic encoding
    "occupation": FeatureType.STRING_CATEGORICAL, # Text categories to embeddings
    "education": FeatureType.INTEGER_CATEGORICAL, # Numeric categories

    # Special types get special treatment
    "feedback": FeatureType.TEXT,                 # Text gets tokenization & embedding
    "signup_date": FeatureType.DATE               # Dates become useful components
}

</div>

Build Your Processor

# Create with smart defaults - one line setup
preprocessor = PreprocessingModel(
    path_data="customer_data.csv",     # Point to your data
    features_specs=features,           # Your feature definitions
    use_distribution_aware=True        # Automatic distribution handling
)

# Build analyzes your data and creates the preprocessing pipeline
result = preprocessor.build_preprocessor()
model = result["model"]                # This is your transformer!

</div>

Process Your Data

# Your data can be a dict, DataFrame, or tensors
new_customer_data = {
    "age": [24, 67, 31],
    "income": [48000, 125000, 52000],
    "occupation": ["developer", "manager", "designer"],
    "education": [4, 5, 3],
    "feedback": ["Great product!", "Could be better", "Love it"],
    "signup_date": ["2023-06-15", "2022-03-22", "2023-10-01"]
}

# Transform into ML-ready features with a single call
processed_features = model(new_customer_data)

# That's it! Your data is now ready for modeling

</div>

🔥 Power Features

Take your preprocessing to the next level with these one-liners:

# Create a more advanced preprocessor
preprocessor = PreprocessingModel(
    path_data="customer_data.csv",
    features_specs=features,

    # Power features - each adds capability
    use_distribution_aware=True,        # Smart distribution handling
    use_advanced_numerical_embedding=True,       # Neural embeddings for numbers
    tabular_attention=True,                      # Learn feature relationships
    feature_selection_placement="all_features",  # Automatic feature importance

    # Add transformers for state-of-the-art performance
    transfo_nr_blocks=2,                # Two transformer blocks
    transfo_nr_heads=4                  # With four attention heads
)

💼 Real-World Examples

👥

Customer Churn Prediction

from kdp import FeatureType, PreprocessingModel

# Perfect setup for churn prediction
preprocessor = PreprocessingModel(
    path_data="customer_data.csv",
    features_specs={
        "days_active": FeatureType.FLOAT_NORMALIZED,
        "monthly_spend": FeatureType.FLOAT_RESCALED,
        "total_purchases": FeatureType.FLOAT_RESCALED,
        "product_category": FeatureType.STRING_CATEGORICAL,
        "last_support_ticket": FeatureType.DATE,
        "support_messages": FeatureType.TEXT
    },
    use_distribution_aware=True,
    feature_selection_placement="all_features",  # Identify churn drivers
    tabular_attention=True                # Model feature interactions
)

</div>

📈

Financial Time Series

from kdp import FeatureType, PreprocessingModel

# Setup for financial forecasting
preprocessor = PreprocessingModel(
    path_data="stock_data.csv",
    features_specs={
        "open": FeatureType.FLOAT_RESCALED,
        "high": FeatureType.FLOAT_RESCALED,
        "low": FeatureType.FLOAT_RESCALED,
        "volume": FeatureType.FLOAT_RESCALED,
        "sector": FeatureType.STRING_CATEGORICAL,
        "date": FeatureType.DATE
    },
    use_advanced_numerical_embedding=True,  # Neural embeddings for price data
    embedding_dim=32,                       # Larger embeddings for complex patterns
    tabular_attention_heads=4            # Multiple attention heads
)

</div>

📱 Production Integration

import tensorflow as tf

# Save your preprocessor after building. This writes model.keras and
# metadata.json into the directory you name.
preprocessor.build_preprocessor()
preprocessor.save_model("customer_churn_preprocessor")

# --- Later in production ---

from kdp import PreprocessingModel

# load_model returns the Keras model AND the metadata it was saved with
loaded_model, metadata = PreprocessingModel.load_model("customer_churn_preprocessor")

# metadata carries features_specs, features_stats, output_mode and use_feature_moe
print(metadata["output_mode"])

# Process new data. Every feature is a column, so each value is a batch of rows.
new_customer = {
    "age": tf.constant([[35.0]]),
    "income": tf.constant([[75000.0]]),
    "city": tf.constant([["paris"]]),
}
features = loaded_model(new_customer)

# Use with your prediction model
prediction = my_model(features)

💡 Pro Tips

Start Simple First

# Begin with basic configuration
basic = PreprocessingModel(features_specs=features)

# Then add advanced features as needed
advanced = PreprocessingModel(
    features_specs=features,
    use_distribution_aware=True,
    tabular_attention=True
)

</div>

Handle Big Data Efficiently

# For large datasets
preprocessor = PreprocessingModel(
    features_specs=features,
    use_caching=True,           # Speed up repeated processing
    batch_size=10000            # Process in manageable chunks
)

</div>

Get Feature Importance

# First enable feature selection when creating the model
preprocessor = PreprocessingModel(
    features_specs=features,
    feature_selection_placement="all_features",  # Required for feature importance
    feature_selection_units=32
)

# Build the preprocessor
preprocessor.build_preprocessor()

# After building, you can get feature importances
importances = preprocessor.get_feature_importances()
print("Most important features:", sorted(
    importances.items(), key=lambda x: x[1], reverse=True
)[:3])

</div>

Keep a Log of the Build

# Mirror KDP's log output into PreprocessModel.log next to your script
preprocessor = PreprocessingModel(
    features_specs=features,
    log_to_file=True            # off by default; console logging stays on
)

</div>

!!! tip "What lands in the log" log_to_file=True adds a file sink to KDP's logger, so the statistics it computes, the layers it assembles and any warning about a feature it could not interpret are written to PreprocessModel.log in the working directory. It is the fastest way to hand a reproducible trace to someone else when a build behaves unexpectedly.

🔗 Where to Next?

🔍

Feature Processing Guide

Deep dive into feature types

📊

Distribution-Aware Encoding

Smart numerical handling

🧠

Advanced Numerical Embeddings

Neural representations

👁️

Tabular Attention

Model feature relationships

🛠️

Complex Examples

Complete real-world scenarios

← Installation Architecture Overview →

Navigation Menu

Uh oh!

🚀 Quick Start Guide: KDP in 5 Minutes

Get your tabular data ML-ready in record time!

🏁 The KDP Experience in 3 Steps

Define Your Features

Build Your Processor

Process Your Data

🔥 Power Features

Take your preprocessing to the next level with these one-liners:

💼 Real-World Examples

Customer Churn Prediction

Financial Time Series

📱 Production Integration

💡 Pro Tips

Start Simple First

Handle Big Data Efficiently

Get Feature Importance

Keep a Log of the Build

🔗 Where to Next?

Feature Processing Guide

Distribution-Aware Encoding

Advanced Numerical Embeddings

Tabular Attention

Complex Examples

Uh oh!

FilesExpand file tree

quick-start.md

Latest commit

History

quick-start.md

File metadata and controls

🚀 Quick Start Guide: KDP in 5 Minutes

Get your tabular data ML-ready in record time!

🏁 The KDP Experience in 3 Steps

Define Your Features

Build Your Processor

Process Your Data

🔥 Power Features

Take your preprocessing to the next level with these one-liners:

💼 Real-World Examples

Customer Churn Prediction

Financial Time Series

📱 Production Integration

💡 Pro Tips

Start Simple First

Handle Big Data Efficiently

Get Feature Importance

Keep a Log of the Build

🔗 Where to Next?

Feature Processing Guide

Distribution-Aware Encoding

Advanced Numerical Embeddings

Tabular Attention

Complex Examples