Skip to main content

A framework for building ML models from natural language

Project description

smolmodels ✨

PyPI version Discord

Build specialized ML models using natural language.

smolmodels is a Python library that lets you create machine learning models by describing what you want them to do in plain English. Instead of wrestling with model architectures and hyperparameters, you simply describe your intent, define your inputs and outputs, and let smolmodels handle the rest.

import pandas as pd
import smolmodels as sm

# Define a house price predictor in terms of intent
model = sm.Model(
    intent="Predict house prices based on property features",
    # input_schema and output_schema are optional
    input_schema={
        "square_feet": float,
        "bedrooms": int,
        "location": str,
        "year_built": int
    },
    output_schema={
        "predicted_price": float
    }
)

# Build the model, using the backend of your choice; optionally generate synthetic training data
model.build(
   dataset=pd.read_csv("house-prices.csv"),
   generate_samples=1000,
   provider="openai:gpt-4o-mini"
)

# Make predictions
price = model.predict({
    "square_feet": 2500,
    "bedrooms": 4,
    "location": "San Francisco",
    "year_built": 1985
})

# Save the model for later use
sm.save_model(model, "house-price-predictor")

How Does It Work?

smolmodels combines graph search with LLMs to generate candidate models that meet the specified intent, and then selects the best model based on performance and constraints. The process consists of four main phases:

  1. Intent Analysis: problem description is analyzed to understand the type of model needed and what metric to optimise for.

  2. Data Generation: synthetic data can be generated to enable model build when there is no training data available, or when the existing data has insufficient coverage of the feature space.

  3. Model Building:

    1. Selects appropriate model architectures
    2. Handles feature engineering
    3. Manages training and validation
  4. Validation & Refinement: the model is tested against constraints and refined using directives (like "optimize for speed" or "prioritize model types with better explainability").

Key Features

📝 Natural Language Intent

Models are defined using natural language descriptions and schema specifications, abstracting away machine learning specifics.

🎲 Data Generation

Built-in synthetic data generation for training and validation.

🎯 Directives for fine-grained Control (Not Yet Implemented - Coming Soon)

Guide the model building process with high-level directives:

from smolmodels import Directive

model.build(directives=[
    Directive("Optimize for inference speed"),
    Directive("Prioritize interpretability")
])

✅ Optional Constraints (Not Yet Implemented - Coming Soon)

Optional declarative constraints for model validation:

from smolmodels import Constraint

# Ensure predictions are always positive
positive_constraint = Constraint(
    lambda inputs, outputs: outputs["predicted_price"] > 0,
    description="Predictions must be positive"
)

model = Model(
    intent="Predict house prices...",
    constraints=[positive_constraint],
    ...
)

🌐 Multi-Provider Support

You can use multiple LLM providers through LiteLLM as a unified backend for model generation. Specify the provider and model in the format provider/model when calling build():

model.build(pd.read_csv("house-prices.csv"), provider="openai/gpt-4o-mini")

Installation & Setup

pip install smolmodels

API Keys

Set your API key as an environment variable based on which provider you want to use. For example:

# For OpenAI
export OPENAI_API_KEY=<your-API-key>

# For Anthropic
export ANTHROPIC_API_KEY=<your-API-key>

[!NOTE] For other providers, check LiteLLM documentation

Quick Start

  1. Define model:
import smolmodels as sm

model = sm.Model(
    intent="Classify customer feedback as positive, negative, or neutral",
    input_schema={"text": str},
    output_schema={"sentiment": str}
)
  1. Build and save:
# Build with existing data
model.build(dataset=pd.read_csv("feedback.csv"), provider="openai:gpt-4o-mini")

# Or generate synthetic data
model.build(generate_samples=1000)

# Save model for later use
sm.save_model(model, "sentiment_model")
  1. Load and use:
# Load existing model
loaded_model = sm.load_model("sentiment_model")

# Make predictions
result = loaded_model.predict({"text": "Great service, highly recommend!"})
print(result["sentiment"])  # "positive"

Benchmarks

Performance evaluated on 20 OpenML benchmark datasets and 12 Kaggle competitions. Higher performance observed on 12/20 OpenML datasets, with remaining datasets showing performance within 0.005 of baseline. Experiments conducted on standard infrastructure (8 vCPUs, 30GB RAM) with 1-hour runtime limit per dataset.

Complete code and results are available at plexe-ai/plexe-results.

Documentation

For full documentation, visit docs.plexe.ai.

Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

License

Apache-2.0 License - see LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

smolmodels-0.4.0.tar.gz (48.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

smolmodels-0.4.0-py3-none-any.whl (67.9 kB view details)

Uploaded Python 3

File details

Details for the file smolmodels-0.4.0.tar.gz.

File metadata

  • Download URL: smolmodels-0.4.0.tar.gz
  • Upload date:
  • Size: 48.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.8 Linux/6.8.0-1020-azure

File hashes

Hashes for smolmodels-0.4.0.tar.gz
Algorithm Hash digest
SHA256 e7d4f9353013be4e36ba0ae4241d62824e921281b79d9e0bcc51a2d46c944421
MD5 4d130a459918728155cbf25ab2dff3e3
BLAKE2b-256 cccf06d4284975985b8c77d63c20fcb71edfd6f12a02506d8794c5fb2a1bdb6d

See more details on using hashes here.

File details

Details for the file smolmodels-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: smolmodels-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 67.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.8 Linux/6.8.0-1020-azure

File hashes

Hashes for smolmodels-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b06407f68bdde08e9e1259742e9d68dc1162f9a9dd5d2fc145d8c27a68542153
MD5 ea38259aec19aaa819541b46f93124ab
BLAKE2b-256 482e85ae1f7b06a16c1b3db0906772ac8e0a07aa332f177d5cfc1a16613d421e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page