Request demo

Installing the SDK

XReduce ships as a Python package on private Gemfury. The Install page covers the full bootstrap script that handles this automatically. This page documents the underlying install for people who want to do it by hand or wire it into their own infrastructure.

Requirements

Python 3.11. The SDK ships cp311 wheels only - Python 3.10 and 3.12 will fail with a "no matching distribution" error.
FURY_TOKEN in your environment. The SDK is on private Gemfury today. Ask the XReduce team if you don't have one yet.
An XReduce account - see API keys for how to get one.

Install

pip install xreduce \
  --extra-index-url https://${FURY_TOKEN}@pypi.fury.io/xreduce/ \
  "xreduce>=1.0.8"

The --extra-index-url tells pip to also check the XReduce private Gemfury index, and the version pin ensures you get a build with current schema support.

Pre-release note. The SDK is on private Gemfury today because XReduce is in early access. Once the platform opens up, the SDK moves to public PyPI and pip install xreduce works without any extra index or token.

Verify

Confirm the CLI is available:

$ xreduce --version
xreduce 1.0.8

$ xreduce --help

usage: xreduce [-h] [--version]
               {login,logout,model,init,remap,profile,evaluate,compare} ...

XReduce - AI workload optimization toolkit

Available commands:
  login     Authenticate and store credentials
  logout    Remove stored credentials
  model     Manage a registered model (create, list, show)
  init      Scaffold a model folder with config templates
  remap     Re-infer benchmarks/config.yaml from the benchmark JSONL
  profile   Run a model inference pass and send telemetry
  evaluate  Evaluate model accuracy against benchmark data
  compare   Compare models head-to-head from the cost-quality matrix

If xreduce isn't found, check that your Python bin directory is on your PATH.

Virtual environments

We recommend installing into a Python 3.11 virtual environment rather than globally:

python3.11 -m venv .venv
source .venv/bin/activate

pip install xreduce \
  --extra-index-url https://${FURY_TOKEN}@pypi.fury.io/xreduce/ \
  "xreduce>=1.0.8"

Keeps XReduce and its dependencies isolated from other Python projects on your machine.

Persisting FURY_TOKEN

Add the token to your shell profile so future shells pick it up automatically:

echo 'export FURY_TOKEN=your_gemfury_token' >> ~/.bashrc
source ~/.bashrc

The bootstrap script (Install) does this for you.

What's next

Authenticate. Run xreduce login - see Account and Authentication.
Run your first evaluation. The Overview page walks through the full 5-command workflow.
Use the Python API directly. See Using the Python API.