Creating a run

To create a new training run and make it available for nodes to join, you'll need to create it, configure it, and unpause it.

Creating the account

First, create the run on-chain. You'll need to provide:

the RPC & websocket RPC urls so the client can communicate with an RPC node.
a unique run ID - just a few characters to uniquely identify your run.
a name & description for your run

Also, for all the commands you will need to provide the path to you Solana private key.

Setup Joining Authorizations

Before we can get started we need to decide who will be able to join the run. You can read more about authorization here.

We'll need a private key that manages join permissions, we'll call it: join_authority.json

Join Authority for Public Runs

If we're looking to make a permissionless run (anyone can join), we'll need to create an authorization that's valid for everyone.

sh scripts/join-authorization-create.sh [RPC] join_authority.json 11111111111111111111111111111111

Join Authority for Private Runs

If we'll only allow some users to join the run we'll need to create one authorization per user (each user can then set multiple delegate keys later)

sh scripts/join-authorization-create.sh [RPC] join_authority.json [MY_USER_PUBKEY]

Creating a run without token rewards

For a standard run without token incentive distribution layer

psyche-solana-client create-run \
    --rpc [RPC] \
    --run-id [RUN_ID] \
    --join-authority [JOIN_AUTHORITY_PUBKEY] \
    --wallet-private-key-path [JSON_PRIVATE_KEY_PATH]

Creating a run with token rewards

For a run that distributes tokens as reward to the training participants, we need to specify the mint of the collateral token to be distributed:

psyche-solana-client create-run \
    --rpc [RPC] \
    --run-id [RUN_ID] \
    --join-authority [JOIN_AUTHORITY_PUBKEY] \
    --treasurer-collateral-mint [COLLATERAL_MINT_PUBKEY] \
    --wallet-private-key-path [JSON_PRIVATE_KEY_PATH]

Initializing configuration

Then, set the run's config. You'll need to provide:

the RPC & websocket RPC urls so the client can communicate with an RPC node.
the run ID you previously used
the path to a config.toml file, following the run config schema

psyche-solana-client update-config \
    --rpc [RPC] \
    --run-id [RUN_ID] \
    --config-path [CONFIG_FILE_PATH] \
    --wallet-private-key-path [JSON_PRIVATE_KEY_PATH]

Starting the training

At this point, your run is ready to go! You can now set its state to "unpaused", and let clients join & begin training your model.

psyche-solana-client set-paused \
    --rpc [RPC] \
    --run-id [RUN_ID] \
    --resume \
    --wallet-private-key-path [JSON_PRIVATE_KEY_PATH]

Congratulations! As soon as your first client joins, your model is being trained.

Configuring training rewards

You can configure how many points does each client earns and loses for each epoch of training.

psyche-solana-client set-future-epoch-rates \
    --rpc [RPC] \
    --run-id [RUN_ID] \
    --earning-rate [EARNING_RATE] \
    --slashing-rate [SLASHING_RATE] \
    --wallet-private-key-path [JSON_PRIVATE_KEY_PATH]

Funding the run with collateral

To distribute collateral to users, we need to periodically top-up the run's treasury so that points earned by users during compute can then be claimed against the treasury.

psyche-solana-client treasurer-top-up-rewards \
    --rpc [RPC] \
    --run-id [RUN_ID] \
    --collateral-amount [COLLATERAL_AMOUNT] \
    --wallet-private-key-path [JSON_PRIVATE_KEY_PATH]

Inspect the content of a run

Optionally you can get detailled technical information about a run that was previously created for troubleshooting purposes.

psyche-solana-client json-info-dump \
    --rpc [RPC] \
    --run-id [RUN_ID]

Psyche