Skip to content

Numerai CLI

Numerai CLI, formerly called Compute Heavy, deploys automated prediction nodes to AWS, Azure, or Google Cloud. Use it when you want Numerai to trigger your model on infrastructure you control.

Requirements

Before starting, you need:

  • A Numerai account with at least one model.
  • A paid account with AWS, Azure, or Google Cloud.
  • Python and Docker installed locally.
  • A Numerai API key.

INFO

The prediction node runs in your cloud account, so you are responsible for its infrastructure costs and maintenance.

API Key Scopes

Create a separate API key for the prediction node with these scopes:

  • View user info, so the CLI can find your models and verify the key.
  • Upload submissions and pickled models, so it can register a webhook and upload predictions.
  • View historical submission info, so numerai node test can verify the uploaded prediction.

Do not grant staking or deletion scopes to a prediction node.

Install and Configure

Follow the provider guide linked from the Numerai CLI repository. After installing the required Python and Docker versions, install the CLI and configure a provider:

bash
python -m pip install --upgrade numerai-cli
numerai setup --provider aws

Replace aws with azure or gcp when appropriate. The setup command asks for the Numerai API key's Public ID and Secret Key, followed by the selected cloud provider's credentials.

Numerai CLI keeps credentials and infrastructure state under ~/.numerai/. Protect and back up that directory, and never add it to a repository.

Deploy a Prediction Node

Configure, deploy, and test a prediction node from your model project:

bash
numerai node config --example tournament-python3
numerai node deploy
numerai node test

Run numerai --help or numerai node --help to see the available options for model names, tournament IDs, instance sizes, and providers. When you update your prediction code or retrain your model, run numerai node deploy and numerai node test again.

Troubleshooting

  • The CLI reports invalid Numerai keys: the CLI verifies keys by reading account information, so its key must include View user info. Run numerai setup again to replace the saved credentials.
  • The CLI cannot find a model: confirm that the model exists in the selected tournament and use numerai node --help to select its name and tournament ID.
  • The node test fails: check the webhook and compute logs in your cloud provider, then rerun numerai node test.
  • The local configuration is lost: use your cloud provider's console to identify resources before recreating the configuration or removing infrastructure.

For provider-specific errors and upgrade instructions, see the Numerai CLI troubleshooting guide.