Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tandemn.com/llms.txt

Use this file to discover all available pages before exploring further.

Pre-requisites

Server:
  • Docker with Docker Compose support
CLI:
  • Python >= 3.12

Server

The following steps are for the sysadmin to bring up Tandemn’s server in order to manage the cluster and handle inference job requests from users. The servers consists of 3 containers, and are bundled in one docker-compose.yml.

Download the release

The server is released as a .tar.xz tarball, bundling a docker-compose.yml and a .env.example.
curl -L -O "https://github.com/Tandemn-Labs/tandemn-system/releases/download/0.0.1/tandemn-0.0.1.tar.gz"
tar -xzf tandemn-0.0.1.tar.gz
cd tandemn-0.0.1

Populate the .env file

Copy the .env.example file into .env and edit the respective parameters.
cp .env.example .env

Bring up the containers

docker compose pull
docker compose up

Client (CLI)

Install the Tandemn CLI

You can do the following in any Python installation or virtual environment
pip install tandemn

Set server URL

export TD_SERVER_URL=<your-server-url>

Check connectivity

tandemn check

Start using the CLI to launch jobs

tandemn deploy Qwen/Qwen2.5-7B-Instruct <some-jsonl-prompt-file> --slo 4
You can look in the CLI documentation section to see details about the commands.

Where to go next

Install the server

Review the deployment flow in more detail.

CLI deploy command

Learn what the deploy command expects.

Architecture

Understand the client-server model.

Troubleshooting

Debug the most common setup issues.