Skip to main content
Two packages run Nori. Pick by where you want the model to run:
  • synthefy-nori is the open-source model itself. It downloads pretrained weights from Hugging Face and runs locally with a scikit-learn–style API. Start here.
  • synthefy is the client. By default it sends your rows to the hosted endpoint and returns predictions, so it needs an API key but no GPU. It can also run the model locally — mode="local" with pip install "synthefy[local]" — so one code path covers both.
Both give you the same model. Use synthefy-nori to run it yourself; use synthefy to call it over the network. The two are independent — you do not need one to use the other.

Optional features

Text columns and SHAP need extra libraries. This installs both:

Forecasting

Local forecasting needs the time-series extra. Install it directly from the open-source model package:
Import it with from synthefy_nori.nori_ts import NoriTSForecaster. See the Forecasting guide for a complete example.

Contributor extras

Only needed if you are working on the package itself, not using it:

Develop from source

Next steps

Nori Quickstart

Fit and predict in five lines, locally or through the hosted API.

API key

Only needed for the hosted API. Running locally needs no key.