Python SDK for Disco API
Project description
Disco Python SDK
Find novel, statistically validated patterns in tabular data — feature interactions, subgroup effects, and conditional relationships that correlation analysis and LLMs miss.
Installation
pip install discovery-engine-api
For pandas DataFrame support:
pip install discovery-engine-api[pandas]
Quick Start
from discovery import Engine
engine = Engine(api_key="disco_...")
result = await engine.discover(
file="data.csv",
target_column="outcome",
)
for pattern in result.patterns:
if pattern.p_value < 0.05 and pattern.novelty_type == "novel":
print(f"{pattern.description} (p={pattern.p_value:.4f})")
print(f"Full report: {result.report_url}")
Get your API key from the Developers page.
Parameters
await engine.discover(
file: str | Path | pd.DataFrame, # Dataset to analyze
target_column: str, # Column to predict/analyze
analysis_depth: int = 2, # 2=default, higher=deeper analysis
visibility: str = "public", # "public" (free) or "private" (credits)
title: str | None = None, # Dataset title
description: str | None = None, # Dataset description
column_descriptions: dict[str, str] | None = None, # Improves pattern explanations
excluded_columns: list[str] | None = None, # Columns to exclude — see below
use_llms: bool = False, # True = LLM explanations (costs more) — see below
timeout: float = 1800, # Max seconds to wait
# Additional kwargs forwarded to run_async():
# task, author, source_url, timeseries_groups, ...
)
Tip: Providing
column_descriptionssignificantly improves pattern explanations. If your columns have non-obvious names, always describe them.
use_llms: DefaultFalse. Slower and more expensive, but you get smarter pre-processing, literature context and novelty assessment. Set toTrueif you want Disco-generated pattern descriptions, novelty assessment with citations, and report summaries. Public runs always use LLMs regardless of this setting. What changes when false: pattern descriptions fall back to generic text, novelty is not assessed (all patterns marked confirmatory, no citations), report summaries are omitted, integer columns with few unique values (e.g. "month" 1-12, "hour" 0-23) may be misclassified as categorical instead of continuous, and high-cardinality text columns get generic cluster names instead of descriptive ones. Useengine.estimate()to check credit cost before running.
Visibility:
"public"runs are free but results are published, and analysis depth is locked to 2."private"runs keep results confidential and consume credits.
excluded_columns: Always exclude identifiers (row IDs, UUIDs), data leakage (target renamed/reformatted), and tautological columns (alternative encodings of the same construct as the target). For example, if your target isserious, excludeserious_outcome,not_serious,death— they're part of the same classification system.
Examples
Working with Pandas DataFrames
import pandas as pd
from discovery import Engine
df = pd.read_csv("data.csv")
engine = Engine(api_key="disco_...")
result = await engine.discover(
file=df,
target_column="outcome",
column_descriptions={
"age": "Patient age in years",
"bmi": "Body mass index",
},
excluded_columns=["patient_id", "timestamp", "outcome_text"], # IDs + tautological
)
Running in the Background
Runs take 3–15 minutes. While waiting, the SDK logs progress automatically:
Waiting for run abc123 to complete...
Status: waiting (position 2 in queue) | Est. wait: ~8 min | Upgrade at disco.leap-labs.com/account for priority processing
Status: processing (preprocessing — Processing data...) | Elapsed: 34.2s | ETA: ~6 min
Status: processing (training — Modelling data...) | Elapsed: 98.7s | ETA: ~4 min
Status: processing (interpreting — Extracting patterns...) | Elapsed: 284.1s | ETA: ~2 min
Status: processing (reporting — Building report...) | Elapsed: 412.3s | ETA: ~1 min
Run completed in 467.8s
If you need to do other work while Disco runs:
import asyncio
from discovery import Engine
async def main():
async with Engine(api_key="disco_...") as engine:
# Submit without waiting
run = await engine.run_async(
file="data.csv",
target_column="outcome",
wait=False,
)
print(f"Submitted run {run.run_id}, continuing...")
# ... do other work ...
# Check back later
result = await engine.wait_for_completion(run.run_id, timeout=1800)
return result
result = asyncio.run(main())
Inspecting Columns Before Running
If you need to see the dataset's columns before choosing a target column — e.g., when column names are not obvious — upload first, inspect, then run without re-uploading:
# Upload once and get the server's parsed column list
upload = await engine.upload_file(file="data.csv", title="My dataset")
# upload["file"] -> {"key": "uploads/abc123.csv", "name": "data.csv",
# "size": 1048576, "fileHash": "sha256:..."}
# upload["columns"] -> [{"name": "col1", "type": "continuous", ...}, ...]
# upload["rowCount"] -> 5000
print(upload["columns"])
print(upload["rowCount"])
# Pass the result to avoid re-uploading
result = await engine.run_async(
file="data.csv",
target_column="col1",
wait=True,
upload_result=upload, # skips the upload step
)
Synchronous Usage
For scripts and Jupyter notebooks:
from discovery import Engine
engine = Engine(api_key="disco_...")
result = engine.run(
file="data.csv",
target_column="outcome",
wait=True,
)
For Jupyter notebooks, install the jupyter extra for engine.run() compatibility:
pip install discovery-engine-api[jupyter]
Or use await engine.discover(...) / await engine.run_async(...) directly in async notebook cells.
Working with Results
# Filter for significant novel patterns
novel = [p for p in result.patterns
if p.p_value < 0.05 and p.novelty_type == "novel"]
# Get patterns that increase the target
increasing = [p for p in result.patterns if p.target_change_direction == "max"]
# Inspect conditions
for pattern in result.patterns:
for cond in pattern.conditions:
print(f" {cond['feature']}: {cond}")
# Feature importance
if result.feature_importance:
top = sorted(result.feature_importance.scores,
key=lambda s: abs(s.score), reverse=True)
# Share the interactive report
print(f"Explore: {result.report_url}")
Credits and Pricing
- Public runs: Free. Results published to public gallery. Locked to depth=2.
- Private runs: Credits scale with file size, depth, and run configuration. $0.10 per credit. Use
engine.estimate()to check cost before running.
# Estimate cost before running
estimate = await engine.estimate(
file_size_mb=10.5,
num_columns=25,
analysis_depth=2,
visibility="private",
)
# estimate["cost"]["credits"] -> 55
# estimate["cost"]["price_usd"] -> 5.5
# estimate["time_estimate"]["estimated_seconds"] -> 360
# estimate["account"]["sufficient"] -> True/False
# estimate["limits"]["max_analysis_depth"] -> 23 (num_columns - 2)
Manage credits and plans at disco.leap-labs.com/account.
Expected Data Format
Disco expects a flat table — columns for features, rows for samples.
- One row per observation — a patient, a sample, a transaction, a measurement, etc.
- One column per feature — numeric, categorical, datetime, or free text are all fine
- One target column — the outcome to analyze. Must have at least 2 distinct values.
- Missing values are OK — Disco handles them automatically. Don't drop rows or impute beforehand.
Not supported: images, raw text documents, nested/hierarchical JSON, multi-sheet Excel (use the first sheet or export to CSV).
File Size Limits
Uploads up to 5 GB. Files are uploaded directly to cloud storage using presigned URLs.
Supported formats: CSV, TSV, Excel (.xlsx), JSON, Parquet, ARFF, Feather.
Return Value
EngineResult
@dataclass
class EngineResult:
run_id: str
report_id: str | None # Report UUID (used in report_url)
status: str # "pending", "processing", "completed", "failed"
dataset_title: str | None # Title of the dataset
dataset_description: str | None # Description of the dataset
total_rows: int | None
target_column: str | None # Column being predicted/analyzed
task: str | None # "regression", "binary_classification", "multiclass_classification"
summary: Summary | None # LLM-generated insights
patterns: list[Pattern] # Discovered patterns (the core output)
columns: list[Column] # Feature info and statistics
correlation_matrix: list[CorrelationEntry] # Feature correlations
feature_importance: FeatureImportance | None # Global importance scores
job_id: str | None # Job ID for tracking
job_status: str | None # Job queue status
queue_position: int | None # Position in queue when pending (1 = next up)
current_step: str | None # Active pipeline step (preprocessing, training, interpreting, reporting)
current_step_message: str | None # Human-readable description of the current step
estimated_seconds: int | None # Estimated total processing time in seconds
estimated_wait_seconds: int | None # Estimated queue wait time in seconds (pending only)
error_message: str | None
report_url: str | None # Shareable link to interactive web report
hints: list[str] # Upgrade hints (non-empty for free-tier users with hidden patterns)
hidden_deep_count: int # Patterns hidden for free-tier accounts (upgrade to see all)
hidden_deep_novel_count: int # Novel patterns hidden for free-tier accounts
Pattern
@dataclass
class Pattern:
id: str
task: str # "regression", "binary_classification", "multiclass_classification"
target_column: str # Column being analyzed
description: str # Human-readable description
conditions: list[dict] # Conditions defining the pattern
p_value: float # FDR-adjusted p-value
p_value_raw: float | None # Raw p-value before adjustment
novelty_type: str # "novel" or "confirmatory"
novelty_explanation: str # Why this is novel or confirmatory
citations: list[dict] # Academic citations
target_change_direction: str # "max" (increases target) or "min" (decreases)
abs_target_change: float # Magnitude of effect
target_score: float # Mean target value (regression) or class fraction (classification) in the subgroup
support_count: int # Rows matching this pattern
support_percentage: float # Percentage of dataset
target_class: str | None # For classification tasks
target_mean: float | None # For regression tasks
target_std: float | None
Pattern Conditions
Each condition in pattern.conditions is a dict with a type field:
Continuous condition — a numeric range:
{
"type": "continuous",
"feature": "age",
"min_value": 45.0,
"max_value": 65.0,
"min_q": 0.35, # quantile of min_value
"max_q": 0.72 # quantile of max_value
}
Categorical condition — a set of values:
{
"type": "categorical",
"feature": "region",
"values": ["north", "east"]
}
Datetime condition — a time range:
{
"type": "datetime",
"feature": "date",
"min_value": 1609459200000, # epoch ms
"max_value": 1640995200000,
"min_datetime": "2021-01-01", # human-readable
"max_datetime": "2022-01-01"
}
Summary
@dataclass
class Summary:
overview: str # High-level summary of findings
key_insights: list[str] # Main takeaways
novel_patterns: PatternGroup # Novel pattern IDs and explanation
selected_pattern_id: str | None # ID of the highlighted/featured pattern
Column
@dataclass
class Column:
id: str
name: str
display_name: str
type: str # "continuous" or "categorical"
data_type: str # "int", "float", "string", "boolean", "datetime"
enabled: bool
description: str | None
mean: float | None
median: float | None
std: float | None
min: float | None
max: float | None
iqr_min: float | None # 25th percentile
iqr_max: float | None # 75th percentile
mode: str | None # Most common value (categorical columns)
approx_unique: int | None # Approximate distinct value count
null_percentage: float | None
feature_importance_score: float | None # Signed importance score
FeatureImportance
Scores are signed — positive means the feature increases the prediction, negative means it decreases it.
@dataclass
class FeatureImportance:
kind: str # "global" | "local"
baseline: float # Baseline model output
scores: list[FeatureImportanceScore]
@dataclass
class FeatureImportanceScore:
feature: str
score: float # Signed importance score
Error Handling
from discovery import Engine
from discovery.errors import (
AuthenticationError,
InsufficientCreditsError,
RateLimitError,
RunFailedError,
RunNotFoundError,
PaymentRequiredError,
)
try:
result = await engine.discover(file="data.csv", target_column="target")
except AuthenticationError as e:
print(e.suggestion) # "Check your API key at https://disco.leap-labs.com/developers"
except InsufficientCreditsError as e:
print(f"Need {e.credits_required}, have {e.credits_available}")
print(e.suggestion) # "Run with visibility='public' (free, results published) or purchase credits with engine.purchase_credits()."
except RateLimitError as e:
print(f"Retry after {e.retry_after} seconds")
except RunFailedError as e:
print(f"Run {e.run_id} failed: {e}")
except RunNotFoundError as e:
print(f"Run {e.run_id} not found — may have been cleaned up")
except PaymentRequiredError as e:
print(e.suggestion) # "Attach a payment method with engine.add_payment_method(...)"
except TimeoutError:
pass # Retrieve later with engine.wait_for_completion(run_id)
All errors include a suggestion field with actionable instructions.
MCP Server
Disco is available as an MCP server with tools for the full discovery lifecycle — estimate, analyze, check status, get results, manage account. To subscribe or purchase credits via MCP, call discovery_add_payment_method first to attach a Stripe payment method.
{
"mcpServers": {
"discovery-engine": {
"url": "https://disco.leap-labs.com/mcp",
"env": { "DISCOVERY_API_KEY": "disco_..." }
}
}
}
Links
- PyPI: discovery-engine-api
- API keys: disco.leap-labs.com/developers
- LLM-friendly docs: disco.leap-labs.com/llms-full.txt
- MCP manifest: disco.leap-labs.com/.well-known/mcp.json
- Credits & billing: disco.leap-labs.com/account
- Public reports: disco.leap-labs.com/discover
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 discovery_engine_api-0.2.99.tar.gz.
File metadata
- Download URL: discovery_engine_api-0.2.99.tar.gz
- Upload date:
- Size: 21.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a34f60da7797bfdcb8f62a99b246303397802f451b3f67d98ad7895a390d19e7
|
|
| MD5 |
b8edc59d1c13e60214dc126c607746cd
|
|
| BLAKE2b-256 |
74c66f84e276c8606766bbd29160747d807c730c4c5a909f47cb25448c90081b
|
File details
Details for the file discovery_engine_api-0.2.99-py3-none-any.whl.
File metadata
- Download URL: discovery_engine_api-0.2.99-py3-none-any.whl
- Upload date:
- Size: 25.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f2f3e2d0e5670697e8fddce9f4f2a4af1fab8730027b2597d698b46630f27e4c
|
|
| MD5 |
ed8a6def08609a69205c3d4f1a37e585
|
|
| BLAKE2b-256 |
269f222c7c50c4dd34e36a15eaee7f376a2ecc394111a0a3d7b43215cc2d304f
|