PreTab is a modular, scikit-learn compatible representation and preprocessing library
for tabular data. A single Preprocessor detects numerical and categorical columns and
turns them into model-ready features. Every strategy it uses (splines, neural basis
expansions, piecewise-linear encoding, binning, kernel approximations, and language
embeddings) is also available as a standalone transformer. Because it speaks the sklearn
API, PreTab drops straight into Pipeline and ColumnTransformer workflows and accepts any
sklearn transformer alongside its own.
Beyond the transformers themselves, every fitted representation is self-describing: it reports per-output-column lineage, guards supervised methods against leakage, serializes to a portable versioned spec, and can be extended with your own representations through a public, discoverable protocol.
- Familiar interface. A scikit-learn
fit/transform/fit_transformAPI that drops into existing pipelines and works with bothpandas.DataFrameandnumpy.ndarrayinputs. - Automatic feature handling. Feature-type detection and per-feature strategies let you describe intent once instead of wiring transformers by hand.
- Beyond scaling. Spline bases, neural basis maps, piecewise-linear encoding, and kernel approximations turn raw numerical columns into expressive representations.
- Categoricals done right. Ordinal and one-hot encoding and pretrained language embeddings cover both low- and high-cardinality columns.
- Self-describing and reproducible. Every fit produces per-column feature lineage and serializes to a portable spec with a stable fingerprint, so you always know what a fitted preprocessor does and can reproduce it exactly.
- Leakage-safe by default. Supervised representations declare their target usage and warn when fit outside a controlled context, with a cross-fitting wrapper for out-of-fold training features.
- Composable and extensible. Every strategy is a standalone transformer you can import, compose, or subclass; register your own representation and it behaves like a built-in.
Tip: See how this compares to scikit-learn's own preprocessing transformers for what each one adds where scope overlaps.
import numpy as np
import pandas as pd
from pretab import Preprocessor
df = pd.DataFrame({
"age": np.random.randint(18, 65, size=100),
"income": np.random.normal(60_000, 15_000, size=100).astype(int),
"city": np.random.choice(["Berlin", "Munich", "Hamburg"], size=100),
})
y = np.random.randn(100)
# Global strategies: PLE for numerics, integer codes for categoricals
preprocessor = Preprocessor(numerical_method="ple", categorical_method="int")
X = preprocessor.fit_transform(df, y) # dict of transformed feature blocks
print({k: v.shape for k, v in X.items()})
# {'num_age': (100, 7), 'num_income': (100, 7), 'cat_city': (100, 1)}Note: PreTab accepts a
pandas.DataFrameor anumpy.ndarrayand infers numerical versus categorical columns either way.
Tip: Swap the global methods for a
feature_preprocessingmap, for example{"age": "ple", "income": "rbf", "city": "one-hot"}, and PreTab fits each column with its own strategy in a single pass. See Usage for a full example.
PreTab groups its transformers into three families. Each one follows the standard fit /
transform API and is importable from pretab.transformers.
| Transformer | Basis | Best for |
|---|---|---|
BSplineTransformer |
B-spline basis | General-purpose smooth nonlinearity |
MSplineTransformer |
Non-negative B-spline basis | Density-like, non-negative bases |
ISplineTransformer |
Monotone integrated spline | Effects that must not reverse |
CubicRegressionSplineTransformer |
Cubic regression spline | GAM-style additive smooth terms |
NaturalCubicSplineTransformer |
Natural cubic spline | Smooth effects with linear tails |
PSplineTransformer |
Penalized B-spline | Smoothness via a difference penalty |
TensorProductSplineTransformer |
Tensor-product spline (multivariate) | Smooth interactions across 2+ features |
ThinPlateSplineTransformer |
Thin-plate spline (multivariate) | Smooth surfaces across 2+ features |
| Transformer | Basis | Best for |
|---|---|---|
RBFExpansionTransformer |
Radial basis functions | Localized, kernel-like features |
ReLUExpansionTransformer |
ReLU basis | Piecewise-linear neural features |
SigmoidExpansionTransformer |
Sigmoid basis | Smooth saturating features |
TanhExpansionTransformer |
Tanh basis | Zero-centered saturating features |
FourierFeatureTransformer |
Sine/cosine basis | Periodic or cyclic numerical effects |
RandomFourierFeaturesTransformer |
Random Fourier features (multivariate) | Scalable RBF-kernel approximation |
NystroemFeaturesTransformer |
Nystroem kernel map (multivariate) | Landmark-based kernel approximation |
| Transformer | Method | Best for |
|---|---|---|
PLETransformer |
Piecewise-linear encoding (supervised) | Strong numerical encoding for models |
NumericBinningTransformer |
Uniform/quantile binning, tree-driven | Discretizing numerical columns |
ContinuousOrdinalTransformer |
Integer (ordinal) encoding | Compact codes for categoricals |
LanguageEmbeddingTransformer |
Pretrained language embeddings | High-cardinality, semantic columns |
Warning:
OneHotFromOrdinalTransformeris deprecated. Usecategorical_method="one-hot"(backed bysklearn.preprocessing.OneHotEncoder) instead.
Note: Inside the
Preprocessoryou select these by short name, for example"ple","rbf","one-hot","pretrained". See Representations for the full catalogue and comparison table.
Full documentation: pretab.readthedocs.io
- Getting Started: Installation and quickstart
- Core Concepts: Configuration, resolution, target awareness, reproducibility
- Representations: The full method catalogue and how to choose one
- Tutorials: Worked, end-to-end examples
- API Reference: The
Preprocessorand every transformer - Developer Guide: Contributing, testing, and releases
Basic installation:
pip install pretabWith optional extras:
pip install "pretab[embeddings]" # adds sentence-transformers, for the `pretrained` strategy
pip install "pretab[lightgbm]" # adds lightgbm, for placement_strategy="lightgbm"
pip install "pretab[all]" # both of the aboveNote: The core install has no heavy dependencies. Each extra is opt-in and only needed if you use the corresponding strategy. PreTab requires Python 3.10 to 3.13.
From source:
git clone https://github.com/OpenTabular/PreTab
cd PreTab
pip install -e ".[dev]"The Preprocessor is the high-level entry point. Set a global strategy per feature type,
or override individual columns with feature_preprocessing.
from pretab import Preprocessor
# Per-feature configuration overrides the global defaults
preprocessor = Preprocessor(
feature_preprocessing={
"age": "ple",
"income": "rbf",
"experience": "quantile",
"city": "one-hot",
},
task="regression",
)
X_dict = preprocessor.fit_transform(df, y) # {"num_age": ..., "cat_city": ...}
X_array = preprocessor.transform(df, return_array=True) # single stacked ndarray
preprocessor.get_feature_info(verbose=True) # inspect resolved strategiesget_feature_info(verbose=True) prints the resolved layout so you can confirm every column
at a glance:
feature kind pipeline dim cats
-------------------------------------------------------------------
age numerical imputer -> minmax -> ple 7 -
income numerical imputer -> minmax -> rbf 7 -
experience numerical imputer -> minmax -> quantile 1 -
city categorical imputer -> onehot -> to_float 4 4
Note:
transformreturns a dict of feature blocks by default (keys prefixednum_andcat_), or a single stacked array when you passreturn_array=True.
Each transformer works on its own and composes with any sklearn estimator.
import numpy as np
from pretab.transformers import PLETransformer
x = np.random.randn(100, 1)
y = np.random.randn(100, 1)
x_ple = PLETransformer(output_dim=15, task="regression").fit_transform(x, y)
assert x_ple.shape[1] == 15Important:
PLETransformeris supervised. It uses the targetyduringfitto place its bin edges and raises if you omit it, so always passywhen fitting it directly.
Because every transformer follows the sklearn API, you can drop them into a Pipeline or
ColumnTransformer.
from sklearn.compose import ColumnTransformer
from sklearn.linear_model import Ridge
from sklearn.pipeline import Pipeline
from pretab.transformers import NaturalCubicSplineTransformer, RBFExpansionTransformer
features = ColumnTransformer([
("age", NaturalCubicSplineTransformer(output_dim=10), ["age"]),
("income", RBFExpansionTransformer(), ["income"]),
])
model = Pipeline([("features", features), ("ridge", Ridge())])
model.fit(df[["age", "income"]], y)Spline transformers expose their penalty matrix for penalized (smoothing) models.
import numpy as np
from pretab.transformers import NaturalCubicSplineTransformer
x = np.random.randn(100, 1)
spline = NaturalCubicSplineTransformer(output_dim=10)
x_spline = spline.fit_transform(x)
penalty = spline.get_penalty_matrix() # (output_dim, output_dim) smoothing penaltyBy default PreTab inspects each column and classifies it as numerical or categorical.
String and object columns are treated as categorical, low-cardinality integer columns are
categorical, and integer columns with enough distinct values stay numerical. Tune the
behavior with cat_cutoff and treat_all_integers_as_numerical.
preprocessor = Preprocessor(
treat_all_integers_as_numerical=False,
cat_cutoff=0.03,
)The pretrained strategy encodes categorical values with a sentence-transformer, which
helps with high-cardinality or semantically rich columns.
preprocessor = Preprocessor(
feature_preprocessing={"job_title": "pretrained"},
)Note: Install with
pip install "pretab[embeddings]"before using thepretrainedstrategy.
NumericBinningTransformer (selected as "custombin") discretizes a numerical column into
uniformly- or quantile-spaced bins, with ordinal, onehot, or soft output encodings.
preprocessor = Preprocessor(
numerical_method="custombin",
output_dim=32,
)Every fitted Preprocessor can explain itself. get_feature_info summarizes the resolved
per-column pipeline, and get_feature_lineage maps every output column back to its source
feature, representation family, and component.
preprocessor.get_feature_info(verbose=True) # resolved strategies, widths, categories
lineage = preprocessor.get_feature_lineage() # one record per output columnMethods like PLETransformer place their bins using the target. PreTab warns when a
supervised transformer is fit outside a Pipeline or cross-validation context, and ships a
cross-fitting wrapper that produces out-of-fold training features.
from pretab import CrossFittedTransformer
from pretab.transformers import PLETransformer
cf = CrossFittedTransformer(PLETransformer(), n_folds=5)
X_train_features = cf.fit_transform(x_train, y_train) # out-of-fold, leakage-freeWarning: Fitting a supervised transformer on the same rows you later evaluate on leaks target information into the features.
CrossFittedTransformerremoves that leakage from the training features themselves; inside aPipeline, cross-validation already keeps each fold's fit confined to its training data.
A fitted preprocessor serializes to a portable, versioned JSON spec, a safer alternative to
pickle that never executes arbitrary code on load, and reports a stable fingerprint for
tracking exactly what was fitted.
preprocessor.to_spec("representation.json")
restored = Preprocessor.from_spec("representation.json")
preprocessor.fingerprint_ # stable sha256 hash of the fitted representationAdd your own representation by subclassing BaseRepresentation, then register it so it
behaves like a built-in, selectable via Preprocessor(numerical_method=...).
from pretab import BaseRepresentation, register_representation
class MyRepresentation(BaseRepresentation):
representation_name = "my_representation"
feature_kind = "numerical"
scope = "univariate"
supervision = "unsupervised"
# implement fit / transform / _output_sizes
register_representation("my_representation", MyRepresentation)Tip: See the custom representation tutorial for a complete, runnable example.
PreTab is licensed under the MIT License. See LICENSE for details.
Contributions are welcome, whether you are fixing bugs, adding transformers, or improving the docs. Clone the repository and install it in editable mode as shown in the Installation section above, then see the Contributing Guide and our Code of Conduct.
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Security: see SECURITY.md for how to report a vulnerability privately.
