A library for deploying Numer.ai Prediction Nodes.
Welcome to Numerai CLI, if you haven't heard of Numerai see our docs to learn more. Currently, this CLI configures a Numerai Prediction Node in Amazon Web Services (AWS) that you can deploy your models to. This solution is architected to cost less than $5/mo on average, but actual costs may vary. It has been tested and found working on MacOS/OSX, Windows 8/10, and Ubuntu 18/20, but should theoretically work anywhere that Docker and Python 3 are available.
If you have any problems, questions, comments, concerns, or general feedback, please refer to the Troubleshooting and Feedback before posting anywhere.
- Getting Started
- Upgrading to 0.3.0
- Node Configuration Tutorial
- List of Commands
- Troubleshooting and Feedback
Sign up a Numerai Account, get your Numerai API Keys, and your first Model:
- Sign up at https://numer.ai/signup and log in to your new account
- Go to https://numer.ai/account > "Your API keys" section > click "Add"
- Name your key and check all boxes under "Scope this key will have"
- Enter your password and click "Confirm"
- Copy your secret public key and secret key somewhere safe
Pick a Cloud Provider and follow the setup directions (Currently we only support AWS):
Install Docker and Python for your Operating System (if you encounter errors or your OS is not supported, please read the troubleshooting wiki to install Python and Docker):
Mac Terminal (cmd + space, type
curl https://raw.githubusercontent.com/numerai/numerai-cli/master/scripts/setup-mac.sh | bash
Ubuntu 18/20 Terminal (ctrl + alt + t):
sudo apt update && sudo apt install -y libcurl4 curl && sudo curl https://raw.githubusercontent.com/numerai/numerai-cli/master/scripts/setup-ubu.sh | sudo bash
Windows 10 Command Prompt (windows key, type
cmd, select Command Prompt):
powershell -command "$Script = Invoke-WebRequest 'https://raw.githubusercontent.com/numerai/numerai-cli/master/scripts/setup-win10.ps1'; $ScriptBlock = [ScriptBlock]::Create($Script.Content); Invoke-Command -ScriptBlock $ScriptBlock"
After the setup script confirms Python and Docker, install
pip3 install --upgrade numerai-cli --user
- This command will also work to update to new versions of the package in the future.
- If you are using python venv then drop the --user option. If you don't know what that is, disregard this note.
Upgrading numerai-cli will always require you to update the package itself using pip:
pip install --upgrade numerai-cli --user
0.1/0.2 -> 0.3.0
CLI 0.3.0 uses a new configuration format that is incompatible with versions 0.1 and 0.2,
but a command to migrate you configuration is provided for you. Run this in the directory
numerai setup from the previous version:
Some updates will make changes to configuration files used by Numerai CLI. These will require you to re-run some commands to upgrade your nodes to the newest versions:
numerai setupwill copy over changes to files in the
numerai node configwill apply those changes to a node
Node Configuration Tutorial
If you know you have all the prerequisites and have your AWS and Numerai API Keys at hand, you can run these commands to get an example node running in minutes:
numerai setup numerai node config --example tournament-python3 numerai node deploy numerai node test
Your compute node is now setup and ready to run. It saves important configuration
$USER_HOME/.numerai/nodes.json including the url for your Node Trigger.
This trigger is registered with whichever model you specified during configuration.
Each trigger will be called Saturday morning right after a new round opens,
and if the related job fails it will be triggered again around 24 hours later.
- The default example does not make stake changes; you will still have to do that manually. Please refer to the numerapi docs for the methods you must call to do this.
- You can view resources and logs in the AWS Console (region us-east-1) for your ECS Cluster and other resources
- If you're getting
NEXT: read the Prediction Nodes wiki to learn about Numerai Examples and how to customize Prediction Nodes.
List of Commands
--help option on any command or sub-command to get a full description of it:
numerai numerai --help numerai [command] --help numerai [command] [sub-command] --help
Each command or sub-command takes its own options, for example if you want to copy the numerai signals example and configure a node for a signals model with large memory requirements you'd use something like this (replacing [MODEL NAME] with the relevant signals model name):
numerai node -m [MODEL NAME] -s config -s mem-lg -e signals-python3
node command takes a model name with
-m and a flag
-s to detect if it's
a signals model or numerai model. The
config sub-command also takes a
-s option to
specify the size of the node to configure.
Troubleshooting and Feedback
Before messaging the Rocketchat channel or creating a Github issue, please read through the following (especially the "Troubleshooting" section in the wiki):
If you still cannot find a solution or answer, please join us on the RocketChat #compute Channel and include the following information with your issue/message:
- The commands you ran that caused the error (even previous commands)
- Version information from running:
pip3 show numerai-cli
- System Information from running
system_profiler SPSoftwareDataType && system_profiler SPHardwareDataType
lsb_release -a && uname -a
powershell -command "Get-ComputerInfo"
If you do not include this information, we cannot help you.
- Thanks to uuazed for their work on numerapi
- Thanks to hellno for starting the Signals ticker map
- Thanks to tit_BTCQASH (numerai profile and twitter profile) for debugging the environment setup process on Windows 8
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for numerai_cli-0.3.4-py3-none-any.whl