Python Client

synthefy and synthefy-nori are two different packages. synthefy-nori is the model; synthefy is the client that calls it. This page covers the client. Its one class, SynthefyNoriClient, runs the same predict call against the hosted service, an Amazon SageMaker endpoint, or a local copy of the model.

One call, every backend

mode="remote" uses the hosted API, mode="sagemaker" uses your AWS endpoint, and mode="local" runs in-process.

Takes DataFrames

Hand it a DataFrame and it aligns columns by name and encodes categoricals for you, rather than making you build a numeric matrix.

More options than these

predict also accepts text columns (needs pip install "synthefy[text]") and discrete-target snapping. See the docstring in nori_client.py.

Retries built in

Timeouts, connection errors, 429s and 5xx are retried with exponential backoff.

Use this page when you want the hosted API, or one code path that works both ways. To run the open-source model directly with no client in between, use NoriRegressor from synthefy-nori instead.

Quickstart

pip install synthefy

Get a key from the API key guide.

import os
from synthefy import SynthefyNoriClient

client = SynthefyNoriClient(
    api_key=os.environ["SYNTHEFY_NORI_API_KEY"],
    model="nori-30m",
)

X_train = [[0.0, 1.0], [1.0, 0.0], [0.5, 0.5], [0.2, 0.8]]
y_train = [0.1, 0.9, 0.5, 0.3]
X_test  = [[0.3, 0.7], [0.8, 0.2]]

print(client.predict(X_train, y_train, X_test))

[0.37, 0.72]

predict returns one float per row of X_test, in order. Pass as_pandas=True to get a pandas.Series instead.

Choosing a mode

mode decides where the model runs. It defaults to "remote".

`mode`	Runs	Needs
`"remote"` (default)	the hosted endpoint	an API key; no GPU, no download
`"sagemaker"`	your SageMaker endpoint	`pip install "synthefy[aws]"`, an endpoint name, and AWS credentials
`"local"`	in-process, via `synthefy-nori`	`pip install "synthefy[local]"`; no key, no network
`"auto"`	local when `synthefy-nori` is importable, else remote	nothing extra

# no key, no network — needs the local extra
client = SynthefyNoriClient(mode="local", model="nori-30m")

# one code path for both: local in development, hosted in production
client = SynthefyNoriClient(mode="auto", model="nori-30m")

"auto" resolves at construction, and the resolved value is readable on client.mode, so you can log which backend you actually got. For Marketplace subscription and endpoint creation, follow the Amazon SageMaker guide.

Predicting from DataFrames

Pass DataFrames and the client builds the numeric matrix for you. X_test is aligned to X_train by column name, so column order does not matter; a mismatch in the column sets raises.

preds = client.predict(df_train, y_train, df_test, as_pandas=True)

Non-numeric columns are encoded, fit on X_train and applied to X_test:

Default (categorical_encoding="ordinal") — each categorical column becomes one column of integer codes, from X_train’s categories in sorted order. A value seen only in X_test maps to -1; missing stays NaN and is imputed server-side.
categorical_encoding="onehot" — one indicator column per category, and missing values get their own indicator.
max_categorical_cardinality (default 100) caps how many distinct values a categorical column may have. Above it the column is dropped, with a warning telling you to encode it yourself.

Configuration

Constructor parameters

Parameter	Default	Description
`model`	required	Size selector (`"nori-6m"`, `"nori-30m"`) or a raw gateway slug. No default; omitting it raises `ValueError`.
`mode`	`"remote"`	`"remote"`, `"sagemaker"`, `"local"`, or `"auto"`. See above.
`api_key`	`None`	Remote mode only. Falls back to the `SYNTHEFY_NORI_API_KEY` environment variable.
`timeout`	`300.0`	Per-request timeout in seconds.
`max_retries`	`2`	Retries on timeouts, connection errors, 429 and 5xx, with exponential backoff.
`auth_scheme`	`"Bearer"`	The gateway needs `"Bearer"`; dedicated deployments use `"Api-Key"`.
`base_url` / `endpoint`	the hosted gateway	Point at a dedicated deployment instead.
`endpoint_name`	`None`	Required with `mode="sagemaker"`; the SageMaker endpoint to invoke.
`region_name`	AWS configuration	AWS region containing the SageMaker endpoint.
`user_agent`	`None`	Custom `User-Agent` header.

predict parameters

Parameter	Default	Description
`as_pandas`	`False`	Return a `pandas.Series` instead of a list.
`categorical_encoding`	`"ordinal"`	`"ordinal"` or `"onehot"`.
`max_categorical_cardinality`	`100`	A non-numeric column with more distinct values than this is dropped, with a warning telling you to encode it yourself.
`discretize`	`None`	Remote mode returns point predictions only, so `"snap-mean"` is the only strategy it supports; the others need `mode="local"`. See Categorical & Ordinal Targets.
`text_columns`	`None`	Names the free-text columns. Needs `pip install "synthefy[text]"`.
`timeout`	inherits the client	Override the timeout for one call.
`extra_headers`	`None`	Additional HTTP headers.

Get Started

Guides

Integration

One call, every backend

Takes DataFrames

More options than these

Retries built in

Quickstart

Choosing a mode

Predicting from DataFrames

Configuration

Next steps

API key

Quickstart

One call, every backend

Takes DataFrames

More options than these

Retries built in

​Quickstart

​Choosing a mode

​Predicting from DataFrames

​Configuration

​Next steps

API key

Quickstart

Quickstart

Choosing a mode

Predicting from DataFrames

Configuration

Next steps