Wrap any trained sklearn/XGBoost model as an LLM-callable tool — auto-generated JSON schemas, Pydantic I/O, OpenAI & LangChain ready, zero boilerplate.
Project description
The bridge between your ML models and LLM agents.
Wrap any trained scikit-learn or XGBoost model as an LLM-callable tool —
auto-generated JSON schemas, typed I/O, zero boilerplate.
tool = ModelTool(model=clf, name="classify_iris", ...)
tool.to_openai() # OpenAI function schema, ready to pass to the API
tool.invoke({"sqft": 2200}) # → {"price_usd": 370730}
Table of Contents
- Why predikit?
- Works with
- Install
- Quick start
- Core API
- Field naming rule
- Cookbook
- Roadmap
- Contributing
- License
Why predikit?
Most ML pipelines stop at .predict(). Getting that prediction callable by an LLM agent — with validated inputs, correct types, and a schema the model can reason about — requires glue code that's tedious to write and easy to get wrong.
predikit handles that layer for you:
| Without predikit | With predikit | |
|---|---|---|
| Schema | Hand-write JSON Schema for every model | Auto-generated from your Pydantic BaseModel |
| Type safety | Manual casting, silent failures | Pydantic v2 validation with clear error messages |
| LLM integration | OpenAI / LangChain boilerplate per model | .to_openai() / .to_langchain() in one line |
| Ensemble routing | Custom aggregation logic per project | ModelEnsemble with 5 built-in strategies |
| Confidence handling | Write your own threshold checks | confidence_threshold + on_low_confidence |
| Model registries | Manual MLflow / Snowflake registry calls | from_mlflow() / from_snowflake() loaders |
| Async | asyncio.get_event_loop().run_in_executor(...) |
await tool.ainvoke(inputs) |
Works with
predikit is designed to plug into the tools your team already uses:
Models — scikit-learn · XGBoost
LLM frameworks — OpenAI function calling · LangChain · any tool-calling API that accepts JSON Schema
Model registries — MLflow Model Registry · Snowflake Model Registry
Validation — Pydantic v2
Async — asyncio-compatible via ainvoke()
Install
pip install predikit
# Optional extras
pip install predikit[xgboost] # XGBoost support
pip install predikit[langchain] # LangChain StructuredTool export
pip install predikit[mlflow] # MLflow Model Registry loader
pip install predikit[snowflake] # Snowflake Model Registry loader
Quick start
from pydantic import BaseModel, Field
from sklearn.datasets import load_iris
from sklearn.linear_model import LogisticRegression
from predikit import ModelTool
# Train
X, y = load_iris(return_X_y=True)
clf = LogisticRegression(max_iter=200).fit(X, y)
# Define what the LLM will pass in
class IrisInput(BaseModel):
sepal_length: float = Field(description="Sepal length in cm")
sepal_width: float = Field(description="Sepal width in cm")
petal_length: float = Field(description="Petal length in cm")
petal_width: float = Field(description="Petal width in cm")
# Wrap the model
tool = ModelTool(
model=clf,
name="classify_iris",
description="Classify an iris flower: 0=setosa, 1=versicolor, 2=virginica.",
input_schema=IrisInput,
output_name="species",
output_description="Predicted species index",
)
# Get an OpenAI-ready schema
import json
print(json.dumps(tool.to_openai(), indent=2))
# Call it directly
tool.invoke({
"sepal_length": 5.1, "sepal_width": 3.5,
"petal_length": 1.4, "petal_width": 0.2,
})
# → {"species": 0}
Core API
ModelTool
ModelTool(
model, # fitted sklearn-compatible estimator
name: str, # tool name the LLM sees
description: str, # tool description the LLM sees
input_schema, # Pydantic BaseModel describing inputs
output_name: str, # key for the prediction in the returned dict
output_description: str,
)
| Method | Returns | What it does |
|---|---|---|
.invoke(input_dict) |
dict |
Validates → predicts → returns {output_name: value} |
.ainvoke(input_dict) |
dict |
Async version of .invoke() |
.to_openai() |
dict |
OpenAI function-calling schema |
.to_langchain() |
StructuredTool |
LangChain tool |
.to_callable() |
Callable |
Plain Python function |
ToolRegistry
Group multiple tools for bulk export:
registry = ToolRegistry([price_tool, risk_tool])
registry.to_openai() # → list[dict], pass directly to OpenAI
registry.to_langchain() # → list[StructuredTool]
registry.get("name") # → ModelTool
ModelEnsemble
Call multiple models and reconcile their outputs in one step:
ModelEnsemble(
tools: list[ModelTool], # models to run in parallel
name: str, # ensemble tool name the LLM sees
description: str,
strategy: str, # "collect" | "mean" | "vote" | "weighted_mean" | "weighted_vote"
weights: list[float], # optional, for weighted strategies
)
| Strategy | Behaviour |
|---|---|
"collect" |
Merges all outputs into one dict (tools can have different output_name) |
"mean" |
Averages numeric outputs (all tools must share output_name) |
"vote" |
Majority class vote (all tools must share output_name) |
"weighted_mean" |
Weighted average — provide a weights list |
"weighted_vote" |
Weighted majority vote — provide a weights list |
ModelEnsemble exposes the same .invoke(), .ainvoke(), .to_openai(), and .to_langchain() interface as ModelTool.
Field naming rule
Your Pydantic schema field names must exactly match the column names the model was trained on.
predikit maps inputs to features by name, not position. If you trained on a DataFrame with columns ["sqft", "bedrooms"], your schema fields must be sqft and bedrooms — not sq_ft, not Sqft.
# ✓ Columns match: sqft, bedrooms, bathrooms
class GoodInput(BaseModel):
sqft: float
bedrooms: float
bathrooms: float
# ✗ Name mismatch — raises ValueError at runtime
class BadInput(BaseModel):
square_footage: float # model expects "sqft"
beds: float # model expects "bedrooms"
baths: float # model expects "bathrooms"
When there's a mismatch, predikit tells you exactly which names are wrong:
ValueError: Input schema is missing model features: ['sqft', 'bedrooms'].
Schema has: ['square_footage', 'beds', 'bathrooms'], model expects: ['sqft', 'bedrooms', 'bathrooms']
Tip: If you trained with a numpy array (no DataFrame), predikit has no feature names to check — it uses your schema's field definition order instead.
Cookbook
XGBoost regression
from xgboost import XGBRegressor
from predikit import ModelTool
reg = XGBRegressor().fit(X_train, y_train)
class HouseInput(BaseModel):
sqft: float
bedrooms: float
year_built: float
tool = ModelTool(
model=reg,
name="price_estimate",
description="Predict home price in USD.",
input_schema=HouseInput,
output_name="price_usd",
output_description="Predicted sale price in USD",
)
Multiple tools in one registry
registry = ToolRegistry([price_tool, risk_tool, demand_tool])
# OpenAI
response = client.chat.completions.create(
model="gpt-4o",
tools=registry.to_openai(),
...
)
# LangChain
agent = initialize_agent(tools=registry.to_langchain(), ...)
Bool inputs from an LLM
LLMs sometimes return "yes", "true", or "1" for boolean fields. predikit coerces these automatically before Pydantic validation:
class Input(BaseModel):
has_pool: bool
tool.invoke({"has_pool": "yes"}) # → coerced to True
tool.invoke({"has_pool": "false"}) # → coerced to False
tool.invoke({"has_pool": "maybe"}) # → raises ValueError with clear message
Supported strings: true/false, yes/no, 1/0, on/off.
Confidence-aware routing
Route uncertain predictions to a fallback tool, or raise an error the agent can catch:
from predikit import ModelTool, LowConfidenceError
tool = ModelTool(
model=clf,
name="churn_risk",
description="Predict member churn risk.",
input_schema=MemberInput,
output_name="churn_probability",
output_description="Probability of churn (0–1)",
confidence_threshold=0.80, # classifiers with predict_proba only
on_low_confidence="warn", # "warn" | "raise" | "fallback"
fallback_tool=rule_based_tool, # used when mode="fallback"
)
result = tool.invoke(inputs)
if result.get("_low_confidence"):
print(f"Uncertain ({result['_confidence']:.2f}) — consider routing to a human")
| mode | behaviour |
|---|---|
"warn" |
returns prediction + _confidence + _low_confidence: True |
"raise" |
raises LowConfidenceError |
"fallback" |
invokes fallback_tool and returns its result |
Only applies to classifiers that implement predict_proba. Regressors are unaffected.
Multi-model ensemble
from predikit import ModelEnsemble, ToolRegistry
ensemble = ModelEnsemble(
tools=[price_tool_a, price_tool_b],
name="averaged_price",
description="Ensemble price: mean of two XGBoost models.",
strategy="mean", # "collect" | "mean" | "vote"
)
result = ensemble.invoke(inputs) # → {"price_usd": 370112}
schema = ensemble.to_openai() # works exactly like ModelTool
Register ensembles alongside individual tools:
registry = ToolRegistry(tools=[price_tool], ensembles=[ensemble])
registry.to_openai() # includes both tools and ensembles
MLflow Model Registry loader
Load a registered MLflow model directly — no manual .load_model() call:
from predikit.loaders import from_mlflow
tool = from_mlflow(
model_uri="models:/churn-classifier/Production",
name="churn_risk",
description="Predict member churn probability.",
input_schema=MemberInput,
output_name="churn_probability",
output_description="Churn probability 0–1",
)
tool.invoke({"tenure_months": 24, "trips_last_year": 2, "avg_spend": 500})
# → {"churn_probability": 0.73}
The loader auto-detects classes_ and feature_names_in_ from the underlying sklearn model, so confidence routing and ensemble work unchanged. Requires pip install predikit[mlflow].
Snowflake Model Registry loader
Load a model registered in the Snowflake Model Registry via the Snowpark ML Python library:
from predikit.loaders import from_snowflake
tool = from_snowflake(
session=snowpark_session,
model_name="VACATION_CHURN",
model_version="V3",
name="churn_risk",
description="Churn classifier.",
input_schema=MemberInput,
output_name="churn_probability",
output_description="Churn probability 0–1",
output_method="predict", # method to call on the Snowflake model object
)
Pass output_method="predict_proba" or any other method your Snowflake model exposes. The returned ModelTool is identical to one built directly — all exporters, confidence routing, and ensemble strategies work as-is. Requires pip install predikit[snowflake].
End-to-end demo
See examples/03_orlando_real_estate.py for a full walkthrough: synthetic dataset → XGBoost training → ModelTool → registry → OpenAI schema → prediction.
Roadmap
Shipped
- OpenAI function-calling schema export
- LangChain
StructuredToolexport - Pydantic v2 typed I/O validation
- Multi-model
ModelEnsemble— collect / mean / vote / weighted variants - Confidence routing —
warn/raise/fallback - Async
ainvoke()via thread pool executor - MLflow Model Registry loader
- Snowflake Model Registry loader
-
predikit inspectCLI
Planned
- HuggingFace / PyTorch / TensorFlow model support
- Streaming inference support
- OpenAI Assistants API integration
- MCP server mode
Contributing
See CONTRIBUTING.md for development setup, code style, and PR guidelines. The CHANGELOG tracks notable changes per release.
Issues and PRs are welcome — if you're wrapping a model type or registry that predikit doesn't support yet, open a discussion.
License
MIT © Tejas Tumakuru Ashok
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file predikit-0.4.5.tar.gz.
File metadata
- Download URL: predikit-0.4.5.tar.gz
- Upload date:
- Size: 1.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
605fa46b462e3ddc7f8bfa7b5143ce194cd17409fedca25280fe0c4add2e7f70
|
|
| MD5 |
fb07d4a8b1eb17fa5c4a46acf8a7be98
|
|
| BLAKE2b-256 |
fa1e4dd3e6ff9e3a1f901834b71410d4720a4b59b16bacfc5966b0fdb6b1cfd0
|
File details
Details for the file predikit-0.4.5-py3-none-any.whl.
File metadata
- Download URL: predikit-0.4.5-py3-none-any.whl
- Upload date:
- Size: 19.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c49c19fd58e9649100e8b4921ade92587a4dccf571e15a1cc3a6fe1ea5adb496
|
|
| MD5 |
4f3ee6f809edf723f5fc7bb8a9dc6f47
|
|
| BLAKE2b-256 |
3604a371b13a25b9717e755e7bf912c68ed9f7ca80b34c9cc4e18a451454f233
|