# Update your miners and restart them on the new Finney network

## During the period between Nakamoto closing and Finney coming up, update all your bittensor repositories to the branch release/3.7.0

cd ~/.bittensor/bittensor

git fetch origin release/3.7.0

git checkout release/3.7.0

python3 -m pip install -e .


## Run SubtensorV3

git clone https://github.com/opentensor/subtensorv3.git

cd subtensorv3

docker-compose up -d


## Add --netuid 3 to your mining script

At ~5pm EST we will open Finney and you will be able to re-run your Server and Validator commands (as normal with the additional --netuid <> argument). If you had a registered miner on the previous Nakamoto network it will still be registered, with stake on the Finney chain on sub-network 3. Your axon-ip endpoint will update automatically when running the miner.

For example, if your mining script is normally:

btcli run


It becomes:

btcli run --netuid 3


Net UID 3 is the only available network at this time.

Over the next 48 hours registrations will be turned off on Finney, giving all miners on the previous network time to begin their Servers/Validators and time for the incentive mechanism to re-stabilize. Devs will be avialable to help people bridge this period on the official Bittensor discord.

# StakePruningMin

The StakePruningMin hyperparemter, which provided deregistration immunity to any key above 1024 stake now only protects the 128 highest staked keys.

# Delegating

Delegation introduces a new way for miners to stake Tao to support the network's most honest and innovative Validators. Any hotkey may nominate themselves as a delegate and receive stake delegations from other wallets in the network. Key owners of delegates collect an 18% "take" on emissions of all delegated Tao. Learn more here

## Turn your hotkey into a delegate

btcli nominate


## Stake to a delegate account

btcli delegate


## List all the delegates in the network

btcli list_delegates


## Show who you are delegating to

btcli my_delegates


# Recycle Registration

A hotkey may now decide between registering through the proof of work or through the recycle_register mechanism, which charges a hotkey a fee paid in Tao. "Recycle register" Tao fees are recycled by adding to the end of the 21 million supply. Like the proof of work, the ''recycle_register fee is dynamic with demand to enter the network.

## Recycle to register with Tao

btcli recycle_register


# Specifying subnetworks

While the Finney upgrade will not introduce any new subnetworks intially, they are on the horizon. Miners need to specify which subnetwork they are mining or registering on with --netuid or by following the user interface prompts.

For example, run on subnetwork 3:

btcli run --netuid 3


# Introduction

Bittensor is an open-source protocol that powers a decentralized, blockchain-based machine learning network. Machine learning models train collaboratively and are rewarded in TAO according to the informational value they offer the collective. TAO also grants external access, allowing users to extract information from the network while tuning its activities to their needs.

Ultimately, our vision is to create a pure market for artificial intelligence, an incentivized arena in which consumers and producers of this valuable commodity can interact in a trustless, open and transparent context.

Bittensor enables:

• A novel, optimized strategy for the development and distribution of artificial intelligence technology by leveraging the possibilities of a distributed ledger. Specifically, its facilitation of open access/ownership, decentralized governance, and the ability to harness globally-distributed resources of computing power and innovation within an incentivized framework.
• An open-source repository of machine intelligence, accessible to anyone, anywhere, thus creating the conditions for open and permission-less innovation on a global internet scale.
• Distribution of rewards and network ownership to users in direct proportion to the value they have added.

# The Protocol

Nakamoto, our main network, is composed of two types of nodes: Servers and Validators. Servers are prompted for information by Validators and given assessments based on the value of their responses. These assessments are then relayed to the network blockchain, Subtensor, where TAO is distributed in proportion. The network runs as per our consensus mechanism such that the most valuable nodes are rewarded with the most stake (TAO), while low-value nodes become weakened to the point of de-registration.

# Taonomics

Bittensor “fair launched” (no tokens were pre-mined) in 2021. The supply of Tao is 21,000,000, and there is a halving cycle such that for every 10.5 million blocks, rewards per block halve. Currently, every 12 seconds (one blockstep), a single Tao emits into the network. There will be 64 halving events, with the first occurring in August 2025. Follow this link to view the current supply and block number.

$\frac{\sum _{i=0}^{32}210000\left[\frac{50*10^8}{2^i}\right]}{10^8}$

Occasionally network updates will require you to manually update Bittensor by pulling and installing the latest master branch.

1. Pull the latest master and install.
git -C ~/.bittensor/bittensor pull origin master
python3 -m pip install -e ~/.bittensor/bittensor


Restarting Servers and Validators follows the same procedure. Simply stop and start your mining sequence after each update to ensure your miners are using the latest version of Bittensor.

# Getting started

This section will guide you through the basic steps necessary to run a miner in the Bittensor network. Considering the rapid expansion of - and competition within - the network since its launch in November 2021, registration difficulty is constantly shifting and there is no guarantee that the same caliber of hardware will always be sufficient. As of now, the bare minimum hardware requirement to register in the network is:

• NVIDIA GPU
• 100GB of disk space
• Ubuntu LTS releases or Macintosh
• A good and stable internet connection

To run a functional Server:

• NVIDIA GPU
• 8GB of VRAM
• 32 GB of RAM
• 200GB of disk space
• Ubuntu LTS releases or Macintosh
• A good and stable internet connection

To run a Validator:

• 16 dedicated CPU cores
• 16 GB of RAM
• 100GB of disk space
• Ubuntu LTS releases or Macintosh
• A good and stable internet connection

as of March 20, 2023 these requirements are subject to increase

## Installing Bittensor

To begin, paste this script into your macOS Terminal or Linux shell prompt:

/bin/bash -c "\$(curl -fsSL https://raw.githubusercontent.com/opentensor/bittensor/master/scripts/install.sh)"


You will be notified when the installation is complete, and the next step will be to create your keys.

Your coldkey remains on your device and holds your "cold storage". Currency in cold storage cannot be used for immediate activity in the network

btcli new_coldkey


You will be prompted to name your wallet (which refers to the coldkey in this instance) and choose a password, before being provided with a unique mnemonic device. Record this information privately and securely.

This key contains your "hot storage": currency that can be used for immediate activity in the network. Your coldkey can have multiple hotkeys attached to it, while each hotkey can only be associated with one coldkey.

btcli new_hotkey


You will be prompted to complete the same steps as with the last key, in addition to specifying which coldkey you would like to connect your hotkey to.

# Running locally - Subtensor

Subtensor is our network blockchain and keeps a record of every transaction that occurs. A new block is created and recorded every 12 seconds - or "blockstep" - at which time a new round of Tao is distributed.

By connecting to Nakamoto, you automatically gain access to Subtensor. Running a Subtensor instance locally, however, will ensure a faster and more consistent experience in the case that the network is compromised or slowed by high traffic. It is therefore highly recommended to run Subtensor locally for serious miners.

## Running Subtensor

Should any of the below commands fail, try running with sudo.

1. Prepare your system by updating outdated packages in your system, and installing the newest available ones. You can do this in two commands.
apt-get update

apt-get upgrade

curl -fsSL https://get.docker.com -o get-docker.sh

1. Make the Docker install script executable.
chmod +x ./get-docker.sh

./get-docker.sh

1. Clone the Subtensor repository.
git clone https://github.com/opentensor/subtensorv3.git

1. Open the Subtensor directory.
cd subtensorv3

1. Pull the latest Subtensor image.
docker pull opentensor/subtensor

1. Run Subtensor inside of Docker.
docker compose up -d

1. Check that Subtensor is fully synced.
docker logs --since=1h node-subtensor 2>&1  | grep "best"


Here is an example of a synced copy of Subtensor:

/node-subtensor    | 2022-04-27 01:32:22 Accepted a new tcp connection from 172.22.0.1:50564.
node-subtensor    | 2022-04-27 01:32:22 Accepted a new tcp connection from 172.22.0.1:50568.
node-subtensor    | 2022-04-27 01:32:22 Accepted a new tcp connection from 172.22.0.1:50572.
node-subtensor    | 2022-04-27 01:32:22 Accepted a new tcp connection from 172.22.0.1:50576.
node-subtensor    | 2022-04-27 01:32:22 Accepted a new tcp connection from 172.22.0.1:50580.
node-subtensor    | 2022-04-27 01:32:22 Accepted a new tcp connection from 172.22.0.1:50584.
node-subtensor    | 2022-04-27 01:32:22 Accepted a new tcp connection from 172.22.0.1:50588.
node-subtensor    | 2022-04-27 01:32:22 Accepted a new tcp connection from 172.22.0.1:50592.
node-subtensor    | 2022-04-27 01:32:22 Accepted a new tcp connection from 172.22.0.1:50596.
node-subtensor    | 2022-04-27 01:32:22 Accepted a new tcp connection from 172.22.0.1:50600.
node-subtensor    | 2022-04-27 01:32:22 Accepted a new tcp connection from 172.22.0.1:50604.
node-subtensor    | 2022-04-27 01:32:22 Accepted a new tcp connection from 172.22.0.1:50608.
node-subtensor    | 2022-04-27 01:32:22 Accepted a new tcp connection from 172.22.0.1:50612.
node-subtensor    | 2022-04-27 01:32:22 Accepted a new tcp connection from 172.22.0.1:50616.


In case your Subtensor goes down, here is the command to restart it:

# quick restart
cd subtensorv3 && \
docker-compose down && \
docker-compose up -d

# full restart
cd subtensorv3 && \
docker-compose down && \
docker system prune -a -f && \
git pull && \
docker pull opentensor/subtensor && \
docker-compose up -d


Lastly, here are the steps to ensure both Bittensor and Subtensor are up to date.

Update Bittensor:

git -C ~/.bittensor/bittensor pull origin master
python3 -m pip install -e ~/.bittensor/bittensor


Update Subtensor:

#Bring Subtensor down
docker compose down
#Connect to directory
cd subtensorv3
#update Subtensor
git pull
#Bring Subtensor back up
docker compose up -d


# Basic btcli

Before you begin customizing your miner, it is useful to familiarize yourself with ourbtcli commands. Btcli is a command line interface to interact with Bittensor, and commands are used to monitor miner performance, transfer Tao, regenerate keys, and run a miner.

## Running a miner

btcli run


## Monitoring

For an overview of all possible btcli commands, enter:

btcli -h


For an overview of all possible flags, enter:

btcli help


For a complete list of all created keys, run:

btcli list


Both the "overview" and "inspect" commands are used to monitor your miner performance:

btcli overview


btcli overview will display the specifics of your progress in the network, and includes your UID, state (active or inactive), stake, rank, trust, consensus, incentive, dividends, and emission. For more information about these performance indicators, refer to the "Consensus Mechanism" section.

btcli inspect


btcli inspect will not display such a detailed analysis of your performance, but will allow you to see your key identifiers, fingerprints, network, balance, stake, and emission.

## Transferring Tao

​ The "unstake" command will transfer Tao from a hotkey to your coldkey.

btcli unstake


The "stake" command will transfer Tao from your coldkey to a hotkey associated.

btcli stake


To expedite longer staking and unstaking operations, you can string these flags to btcli stake and btcli unstake:

#stake or unstake from all hotkeys
--wallet.all_hotkeys
#stake or unstake from a specific set of hotkeys
--wallet.hotkeys <>
#stake or unstake from all hotkeys while exluding a specific set of hotkeys
--wallet.exclude_hotkeys <>
#stake or unstake to a specific amount of stake on a hotkey
--max_stake <>


This command moves Tao between coldkeys. A .125 tao burn fee is applied.

btcli transfer


## Key regeneration

If you lose access to your keys, they can be easily regenerated with the unique mnemonic device you were provided with upon initial creation.

Regen a full coldkey:

btcli regen_coldkey


To regen only the public portion of a coldkey:

btcli regen_coldkeypub --ss58 <>


Regen a hotkey:

btcli regen_hotkey


## Delegating

Nominate your hotkey as a delegate:

btcli nominate


Delegate stake to someone else's delegate hotkey:

btcli delegate


View a list of all delegate hotkeys:

btcli list_delegates


Show who you are delegating to:

btcli my_delegates


# Registration

## Registering a hotkey

Before you can begin mining Tao, you must first register a hotkey to the network by solving the proof of work (POW) or by paying a fee with recycle_register. The Bittensor network is comprised of 4096 miners, and each time a new hotkey is registered to the network, the lowest ranked miner is kicked off of the network. POW registration will likely require GPUs.

## Registering with a GPU

Before you can utilize the CUDA registration, you must first install CUDA-toolkit and cubit. Please note that CUDA registration only supports sm_86 enabled CUDA GPU (30XX series, Axxxx series or higher) Other GPUs may require additional configuration for registration.

### Installing CUDA-toolkit

Install CUDA-toolkit 11.3 or higher in accordance with your operating system and version if you have yet to do so. deb(local), deb(network), and runfile(local) should each be sufficient installer types.

### Enter the Bittensor directory

cd ~/.bittensor/bittensor


### Install cubit

pip install git+https://github.com/opentensor/cubit.git@v1.1.2


### Troubleshooting and testing

Should the previous installation fail, you may install from source or a wheel: cubit installation

You can check if your GPU is being seen through torch:

python3
>>> import torch
>>> torch.cuda.is_available()


A quick way to test if the GPU registration process is working properly is by choosing the test network, Nobunaga, upon the miner startup described below. Registration to the Nobunaga network should only take a few minutes. Additional configurations may optimize your registration speed. Please see here for a full list of CUDA registration flags.

With your keys created and CUDA registration installed, you can now register your miner.

btcli register --cuda


Alternatively you may register and run your miner with recycle register.

btcli recycle_register


You will be immediately prompted to:

## Enter a chain

To immediately gain access to Subtensor - our network blockchain - choose finney.” Finney is useful for quick connections to the network like checking your wallet balance, however it is not reliable for mining. For serious miners we recommend running an instance of Subtensor locally in order to maximize speed and connection. Should you be running Subtensor locally, choose “local.”

To familiarize yourself with the protocol without mining, choose our test network, Nobunaga

## Enter a network uid

Enter the subnetwork that you wish to register too.

Enter the name of your coldkey and hotkey credentials. note: you will need a separate hotkey for each miner you register.

Once your miner is registered in the network and you have Subtensor running locally, you are ready to begin Serving or Validating.

This area of the documentation will guide you through how to Serve and Validate on the network, and how to make basic customizations with flags in order to set your miner up for success in the network. Pair these flags with calls to btcli or any other mining start command.

You may also configure your miner through a config file or environment variables. See Methods of Configuration and Configuration Settings for more.

# Running a miner

To run a basic miner with no specific conficurations:

btcli run


You may add flags to your btcli run mining script to customize how you would like your miner to behave.

To run with GPU or CPU:

--neuron.device <cuda | cpu>


## Choosing a chain

This argument specifies which instance of Subtensor you will connect to: a local copy, the public Finney copy, or the test chain Nobunaga.

--subtensor.network <local | nobunaga | finney>


You can also select a network endpoint:

--subtensor.chain_endpoint <>


## Choosing a subnetwork

This argument specifies which subnetwork you would like to mine on.

--netuid <>


## Specifying a wallet

Every running miner must be connected to a registered hotkey. This code will specify which coldkey (wallet) you wanted to use, as well as the corresponding hotkey.

--wallet.name <>

--wallet.hotkey <>


## Specifying a port

Specifying a port to which to access the network is important because you will benefit from entering a low traffic area. This will generally be one above 1024 and below 65535. Each miner needs to have a unique port, so if you have two miners running on the same machine, they will require two separate ports.

The miner communicates with the network through its communication endpoint, the axon. This is where the argument is made.

--axon.port <>


ex.

--axon.port 8090


## Restarting you miner

Only use this argument when if wish to restart your training from the beginning. This will reset all training progress.

--neuron.restart


## Different ways to start a miner

This is for advanced or power users of Bittensor

Sometimes you may want to create your own validator or your own server, in which case btcli will not work as it is pointed at specific files within the Bittensor repository. The following commands demonstrate how to run your own custom script along with the same Bittensor flags. Note that the path of the script that the command examples are using are the same ones that btcli uses currently.

python3 -u ~/.bittensor/bittensor/bittensor/_neuron/text/<core_server | core_validator>/main.py --no_prompt --subtensor.network local --wallet.name <> --wallet.hotkey <>


Process managers like PM2 and TMUX are another option, however since they are not a part of Bittensor, they will not be a part of this documentation.

# Customizing your miner - Server

When you first enter the network, you will likely be running a Server. Until you have accrued ~1000 Tao, serving is the only way to mine a significant amount of Tao, and the ultimate goal is to upgrade, customize and design your model in such a way as to optimize this.

## Choosing a model

By default, your miner is outfitted with the gpt2 model. While the ultimate goals is to upgrade, customize, and design your own model from scratch, choosing one from Hugging Face is a good place to start.

Attach these arguments to the end of a btcli call or mining start command.

--neuron.model_name <>


For example, if you want to run Eleuther AI's gpt-j-6B model:

--neuron.model_name EleutherAI/gpt-j-6B


As expected, the larger the model is, the more computational resources it will need to run smoothly on the network.

View Hugging Face for more options or finetune your own!

## Choosing peers

By associating only with high-stake Validators, Servers are able to optimize their inflation. Using the "blacklist" argument, you can decide the minimum stake a Validator must have to send a forward request.

--neuron.blacklist.stake.forward <>


The padding parameter adjusts the embedding dimensions for your model to match the network dimension, which is currently set to 1024. By default, the padding is turned on, however, while this is useful for smaller models, it might be useful to turn it off for larger models.

--neuron.padding false


## Allocating Tao

The more Tao you have staked to a hotkey, the more protection that hotkey has from getting deregistered in the network. However, Tao staked in your hotkey, as a Server, does not increase your dividends.

## Preventing timeouts

Optimizing request speed is essential for mining. The faster your Server can process Validator requests, the better its earnings will be. A Server must be able to process a request within one blockstep, or else a timeout will occur. If this happens, you will need to improve your connection, or your hardware. As a server, you are only concerned with forward requests, and timeouts here mean your Server cannot computationally keep up with the demands of the network.

View your timeouts on your "logs" that pop up the moment your miner starts to run when using:

--logging.debug


This will show you requests on the axon and the dendrite as well as weights set on the chain.

# Customizing your miner - Validator

The Core Validator finetunes on the bittensor network with a mixture of experts model and shapely scoring. The Validator's main jobs are to identify important/useful peers in the network and to correctly weight them. To achieve this, the Validator will send requests to different peers on the network and evaluate their responses.

Running a Validator becomes beneficial only once you have accrued a significant amount of Tao. This is due to the bonding matrix: Validators accrue currency in proportion to their stake due to the existence of dividends. Validators need to maintain a stake within the top 128 hotkeys on the network in order to set weights and stay registered.

In addition, Validators are less sensitive to disconnection compared to Servers, who's incentive will begin falling within 20 minutes of disconnection (100 blocks). Validators, however, will only become inactive after ~5000 blocks.

## Running a Validator

Any registered hotkey can be used to run a Validator, and it is as simple as running this command:

btcli run


Choose core_validator

## Staking Tao

If you are running a Validator, the more Tao you have staked in your hotkey, the more inflation through dividends you will earn. Refer to Wallet to see the commands for transferring and staking Tao.

# Delegation

Any hotkey may become a delegate and receive nominations of stake from other wallets in the network. Key owners of delegates collect an 18% "take" on emissions of all delegated Tao.

When a coldkey creates a hotkey delegate, it will receive all of the emissions from the stake it adds to its hotkey delegate. The delegate owner will also collect 18% of the emissions from all delegated stake.

## Turn your hotkey into a delegate:

btcli nominate


## Stake to a delegate account:

btcli delegate


## List all the delegates in the network:

btcli list_delegates


## Show who you are delegating to:

btcli my_delegates


E = emissions earned by the key per block

Sn = Stake from owner

St = Total stake on hotkey

Delegate key owner

Emissions received = E * 0.18+(Sn/St)*(E-E * .18)

Delegated stake owners

Emissions received = (Sn/St)*(E-E * .18)

~delegated stake owners pay an 18% tax through emissions

# Staking to a Delegate

In addition to running your own miner or validator, you also have the option to delegate your Tao to the Opentensor Foundation validation pool. In essence, delegating Tao simply means you are staking to the foundation's validator, instead of running your own. You can simply 'undelegate' your Tao to take it back from the pool at any time.

For a list of Delegates and their hotkeys: https://github.com/opentensor/bittensor/blob/master/delegates.json

2. Navigate to Developer -> extrinsics.

3. In the drop down, select SubtensorModule.

4. In the drop down menu corresponding to the SubtensorModule drop down, select addStake.(If you want to undelegate, select removeStake )

5. Paste the hotkey of the delegate in the drop down box labeled hotkey.

6. In the text box, input in Rao the amount of Tao that you wish to stake to this delegate. 1 Tao = 10^9 Rao. Therefore, if you wish to stake 1 Tao, then input 1000000000. If you wish to stake 10 Tao, then input 10000000000, and so on.

7. Once you have verified the keys and amounts, click Submit Transaction to sign and submit this transaction to be included on the chain.

# CLM Model Tuning

Note: This script was adapted from Hugging Face's Transformers/language-modeling code.

Welcome to the CLM Model Tuning walkthrough. This section will guide you through how to install and use our guide to fine-tune your models.

# Language model tuning preface

Fine-tuning the library models for language modeling on a text dataset for models like GPT and GPT-2. Causal languages like this are trained or fine-tuned using a causal language modeling (CLM) loss.

In theory, serving a tuned model can increase incentive and earnings on the Bittensor network. However this depends on many factors: the choice of model, the data used for tuning, and (to a lesser extent), the hyperparameters used for tuning itself. This is not a silver bullet that will immediately guarantee higher earnings, but differences will be more pronounced once the Synapse update is released (time of writing: July 25, 2022).

In the following examples, we will run on datasets hosted on Bittensor's IPFS Genesis Dataset, on Hugging Face's dataset hub, or with your own text files.

For a full list of models that will work with this script, refer to this link.

## Installation and requirements

This code assumes you have Bittensor already installed on your machine and is meant to be run entirely separately. Some basic linux command line knowledge is assumed, but this guide should provide a good starting point to navigate and move around files, directories, etc.

To start, clone this repository:

git clone https://github.com/opentensor/clm_model_tuning


Install the additional packages for this script:

pip install -r requirements.txt


All of the following commands assume you are working from this folder:

cd clm_model_tuning


## Fine-tuning on Bittensor

By default, this script will fine-tune GPT2 for Bittensor's mountain dataset. Running:

python3 finetune_using_clm.py


will tune gpt2 with Bittensor's dataset and save the output to tuned-model.

To change the model you are tuning to, e.g. distilgpt2, run:

python3 finetune_using_clm.py model.name=distilgpt2


A full list of models that can be trained by this script are available on Hugging Face.

## Fine-tuning on Hugging Face datasets

Any text dataset on Hugging Face should work by default by overriding the dataset.name and dataset.config parameters:

python3 finetune_using_clm.py dataset.name=wikitext dataset.config_name=wikitext-103-v1


## Fine-tuning on your own data

If you have a .txt file saved locally, you can override dataset.name:

python3 finetune_using_clm.py dataset.name=./path/to/your/data.txt


Note if using your own data, you may have many short sentences and the block size may be insufficient for reasonable performance. It's recommended you pass the flag dataset.concatenate_raw=true to give the model more context when training. This will reduce the number of batches.

## Configuring training parameters

All configurable parameters are visible and documented in conf/config.yaml. The defaults are chosen for quick training and not tuned; you will need to experiment and adjust these.

Note: The above parameters are the only commands you can override with this script. That is, you may not pass flags you would normally use when running btcli (i.e. --neuron.device will not work). If there is a flag you wish to modify feel free to submit a feature request.

To view the changeable parameters, open conf/config.yaml in whatever text editor you prefer, or use cat conf/config.yaml to view them.

You do not need to edit this file to change the parameters; they may be overridden when you call this script. e.g., if you wish to change the model to distilgpt2, and the output directory to distilgpt-tuned, you would run:

python3 finetune_using_clm.py model.name=distilgpt2 output_dir=distilgpt-tuned


Note the nested structure in the config, since model is above name in conf.yaml, you must override model.name when invoking the command.

## Serving custom models on Bittensor

To serve your tuned model on Bittensor, just override neuron.model_name with the path to your tuned model:

btcli run ..... --neuron.model_name=/home/{YOUR_USENAME}/clm_model_tuning/tuned-model


## Limitations and warnings

Early stopping is not yet supported. Many features are implemented but not thoroughly tested, if you encounter an issue, reach out on discord or (preferably) create an issue on this github page.

# Configuring a miner

There are three ways to configure your miner:

1. Command line arguments
2. Configuration file
3. Environment variables

Command line arguments take the highest priority with environmental variables being the lowest.

• Command Line —> Config —> Environment Variables

## Command line arguments

Command line arguments take the form of flags and can be strung to btcli calls or your miner run command.

For example, specify which port to use:

btcli run --axon.port <>


Full list of command line arguments

## Configuration file

Another way to configure your miner is through the configuration file. To call upon a configuration file, pass:

--config.file <path_to_configuration_file>
# e.g.
btcli run --config.file my_config_directory/my_custom_config_file.txt


Refer to sample configuration files

## Environment variables

The final way to configure a miner is through environment variables.

All environment variables have the same structure:

BT_<object name>_<parameter name>


To change an environment variable:

export BT_VARIABLE_I_WISH_TO_CHANGE=<>


For example, if you wanted to specify the default port to 3000:

export BT_AXON_PORT=3000


Full list of environment variables

# The Mountain Dataset

The Mountain Dataset is a Bittensor’s current language modeling dataset consisting of a set of smaller datasets combined together. Currently, it contains ~800 Gb of unlabeled text.

Servers in Bittensor are validated for their ability to understand the text contained in the The Mountain Dataset. To do this, Validators query Servers who must produce embeddings and token predictions in response. Scores derived from these responses determine the incentives Servers see, thus guiding the network to understand the dataset better.

## Storage

In order to ensure global access and make the network robust to single points of failure, The Mountain is stored on The InterPlanetary File System (IPFS) as a set of small chunks, files no larger than 1Mb, each containing a small sample of the larger dataset. These small chunks are organized into a set of 22 datasets each with a standard data format, for instance, Arxiv articles or Github code.

## Querying

Every file on The Mountain can be accessed via its unique hash. These can be queried directly using a tool like Curl and the hash of the file. For instance, we can query an individual file like so.

Command:

curl -X POST "http://ipfs.opentensor.ai/api/v0/object/get?arg=Qme2dawBzozFGtKWX73fh5fmB8NJD7TRS2XSWKhJB4WbJd"


Output:

"Data": Right now, American protest music sounds like\nthis.\n...we don’t believe you, cuz we the people...\n...a million dollar loan.
...


## Organization

The Mountain is organized under the following hash:

QmSdDg6V9dgpdAFtActs75Qfc36qJtm9y8a7yrQ1rHm7ZX


Querying this hash returns the subdirectories of the dataset, for instance, Arxiv, which make up the entire dataset.

Command:

curl -X POST "http://ipfs.opentensor.ai/api/v0/object/get?arg=QmSdDg6V9dgpdAFtActs75Qfc36qJtm9y8a7yrQ1rHm7ZX"


Output:

"Name":"Youtube",
"Hash":"Qme9Rpu1zFT4d2wxzVYiFWHGMDfFkZcQoAougjJreS5nuF",
"Size":262158

"Name":"Arxiv",
"Hash":"QmXABX5KyBsCvi7XzRZVKgAoovR2KgTo45FM51YRnV7hAJ",
"Size": 262158

"Name":"Github",
"Hash":"QmZQwJp21jijtpRpeFD3ZM6p7HLGErde9EgY7Zz8ZRnVuW",
"Size":2 62158
...


The hash of each item above points to a file containing hashes to all text files in that directory. For instance, querying the first element from the list above returns the list of hashes associated with all files in the “Youtube” dataset.

Command:

curl -X POST "http://ipfs.opentensor.ai/api/v0/object/get?arg=QmUzpNL94qN7RFYUkeji2ZGgDDiWALM1MXwu74RNmcov6Q


Output:

"Name": "01-YoutubeSubtitles-5899.txt"
"Hash": "QmSj7mzxdDw8gd8rqqzijCDxsUs8YRi6EsJtRWiLsHA9Ce",
"Size": 5173

"Hash": "Qme2dawBzozFGtKWX73fh5fmB8NJD7TRS2XSWKhJB4WbJd",
"Size": 885

"Hash": "QmUSzQgkamYWVhv938nbQgPrQz7CNfpmiUaF36z6Nx6Uzz",
"Size": 6710
...


# Glossary

## Miner Architecture

### Miner/Neuron/Peer/Node

Used interchangeably to refer to a participant in the network.

### Hotkey

The part of the miner that contains "hot storage". It is loaded into the network and gives ability to set weights (for Validators).

### Coldkey

The part of the miner that contains cold storage. Remains on device.

### Axon

Miners receive requests from other peers in the network via the axon.

### Dendrite

Miners send requests to other peers in the network via the dendrite.

### Metagraph

A Python torch object that produces a view into the network. This tool is used internally by miners and also for network analysis.

## Network

### Tao

The digital token that functions as currency in the network. Tao uses the same tokenomics as Bitcoin with a 4 year halving cycle and a max supply of 21 millions tokens.

### Subtensor

The network blockchain.

### Nakamoto

Our main network.

### Nobunaga

Our test network.

### Block step

Occurs every 12 seconds. The blockchain is updated, and newly minted Tao is distributed to the system.

### UID

The unique identifying number for each Miner. Represents its position in the network. There are currently 4096 UIDs available in the network.

### Forward Requests

The first stage of the transaction in which a Validator sends data to a Server in the form of tokens, and the the Server sends embeddings back.

### Backward Requests

The second stage of the transaction in which the Validator sends feedback (in the form of gradients) to the Server.

## Consensus Mechanism

### Stake

Equivalent to the amount of Tao attached to the Miner's hotkey. For Validators, more stake translates to rankings being worth more. For Servers, more stake translates to a lower likelihood of being deregistered from the network.

### Rank

The raw score given to a Server by a Validators, combined with the stake of the Validator.

### Trust

This score represents the number of non-zero (approval) rankings that Servers receives from Validators. The trust score is used to determine whether a Server has achieved consensus in the network. The more stake a Validator has, the more trust scores it can distribute.

### Consensus

Achievement of a Server who has received a non-zero ranking from more than 50% of the stake in the network. Servers who reach consensus receive significantly higher rewards than those who have not.

### Incentive

The inflation achieved by a Server before dividends are distributed. The incentive is a combination of the rank and consensus scores.

### Inflation

The amount of currency (1 tao) released into the network at each block step. The single Tao is distributed amongst all peers in the network according to their performance.

### Emissions

Refers to the portion of the one Tao distributed to a single peer each block step.

### Dividends

When Validators rank Servers, they take on part ownership of them through the bonding matrix. When a Server's incentive is calculated, a portion of this is distributed to Validators who have bonds.

### Bonding Matrix

Refers to the bonds that Validators hold in Servers. The higher the stake the Validator has, and the more staked in the Server, the larger the dividend the Validator will receive.

### Embeddings

Also referred to as representations, embeddings are a way of expressing information (i.e the comprehensible meaning of a word) as a very high-dimensional vector.

### Logits

The probability of a word in NTP (next token prediction) or MTP (masked token prediction).

### Next Token Prediction

Predicting an answer given a context before the place of prediction (i.e. predicting the next word in a sentence).

Predicting an answer given a context before and after the place of prediction (i.e. predicting the next word in a sentence).

### Shapely Value

A measure of individuals' contributions in a cooperative game.

### Dataset

Bittensor uses a 1.5 Terrabyte corpus dataset for training known as the Mountain.

### Sigmoid Function

The sigmoid produces a threshold-like scaling that rewards connected peers and punishes the non-trusted.

### Chain Security

Connecting to the Polkadot infrastructure will offer greater network security. Polkadot takes the concept of validation security away from the chain so that the Polkadot relay chain is now responsible for security. Read more about Polkadot security.

# Configuration Settings

--config.file

• If set, defaults are overridden by the passed file.
--config.strict

• If flagged, config.file will check that only exact arguments have been set.

## Neuron

--neuron.learning_rate
neuron.learning_rate:

• Training initial learning rate.
--neuron.momentum
neuron.momentum:

• Optimizer for momentum.
--neuron.clip_gradients

• Implement gradient clipping to avoid exploding loss on smaller architectures.
--neuron.device
neuron.device:

• Miner default training device CPU/CUDA.
--neuron.model_name
neuron.model_name:

• Pretrained model from hugging face.
--neuron.pretrained
neuron.pretrained:

• If the model should be pretrained.
--neuron.padding

• To pad out final dimensions.
--neuron.interpolate
neuron.interpolate:

• To interpolate between sentence length.
--neuron.inter_degree
neuron.inter_degree:

• Interpolate algorithm (nearest | linear | bilinear | bicubic | trilinear | area)
--neuron.name
neuron.name:

• Trials for this miner go in miner.root / (wallet_cold - wallet_hot) / miner.name
--neuron.checking
neuron.checking:

• To check if server settings are correct.
--neuron.restart
neuron.restart:

• If set, train the neuron from the beginning.
--neuron.blacklist.stake.forward
neuron.blacklist.stake.forward:

• Amount of stake (Tao) in order not to get blacklisted for forward requests.
--neuron.blacklist.stake.backward
neuron.blacklist.stake.backward:

• Amount of stake (Tao) in order not to get blacklisted for backward requests.
--neuron.metagraph_sync

• How often to sync the metagraph.
--neuron.blocks_per_set_weights

• How often to sync set weights.
--neuron.blocks_per_epoch
neuron.blocks_per_epoch:

• Blocks per epoch.
--neuron.blacklist.time
neuron.blacklist.time:

• How often a peer can query you (seconds).
--neuron.local_train
neruon.local_train:

• Allow local training. local_train is "false" by default. Do not set to "false."
--neuron.remote_train
neuron.remote_train:

• Allow remote training. Remote training is "false" by default. Do not set to "false."
--neuron.validation_synapse
neuron.validation_synapse:

• For Validators only. Synpase used for validation <TextCausalLMNext | TextCausalLM>. Default TextCausalLMNext. This should generally not be used.

## Wallet

--wallet.name
wallet.name:
BT_WALLET_NAME

• The name of the wallet to unlock for running bittensor (name mock is reserved for mocking this wallet).
--wallet.hotkey
wallet.hotkey:
BT_WALLET_HOTKEY

• The name of the wallet's hotkey.
--wallet.path
wallet.path:
BT_WALLET_PATH

• The path to your bittensor wallets.
--wallet._mock
wallet._mock:
BT_WALLET_MOCK

• To turn on wallet mocking for testing purposes.
--wallet.all_hotkeys

• Stake or unstake from all hotkeys simultaneously.
--wallet.hotkeys

• Stake or unstake from a specific set of hotkeys simultaneously.
--wallet.exclude_hotkeys

• Stake or unstake from all hotkeys simultaneously while exluding a specific set of hotkeys.
--wallet.sort_by

• Sort the hotkeys by the specified column title (e.g. name, uid, axon).
--wallet.sort_order

• Sort the hotkeys in the specified ordering. (ascending/asc or descending/desc/reverse).
--wallet.reregister

• Whether to reregister the wallet if it is not already registered.
--max_stake

• Stake or unstake to a specific amount of stake on a hotkey.

## Axon

--axon.port
axon.port:
BT_AXON_PORT

• The port this axon endpoint is served on. i.e. 8091
--axon.ip
axon.ip:
BT_AXON_IP

• The local ip this axon binds to. ie. [::]
--axon.max_workers
axon.max_workers:
BT_AXON_MAX_WORERS

• The maximum number connection handler threads working simultaneously on this endpoint. The grpc server distributes new worker threads to service requests up to this number.
--axon.maximum_concurrent_rpcs
axon.maximum_concurrent_rpcs:
BT_AXON_MAXIMUM_CONCURRENT_RPCS

• Maximum number of allowed active connections.
--axon.backward_timeout
axon.backward_timeout:

• Number of seconds to wait for backward axon request.
--axon.forward_timeout
axon.forward_timeout:

• Number of seconds to wait for forward axon request.
--axon.priority.max_workers
axon.priority.max_workers:
BT_AXON_PRIORITY_MAX_WORKERS

--axon.priority.maxsize
axon.priority.maxsize:
BT_AXON_PRIORITY_MAXSIZE

• Maximum size of tasks in the priority queue.
--axon.compression

• Which compression algorithm to use for compression (gzip, deflate, NoCompression).

## Dendrite

--dendrite.timeout
dendrite.timeout:
BT_DENDRITE_TIMEOUT

• Default request timeout.
--dendrite.max_worker_threads

• Max number of concurrent threads used for sending RPC requests.
--dendrite.max_active_receptors
dendrite.max_active_receptors:
BT_DENDRITE_MAX_ACTIVE_RECEPTORS

• Max number of concurrently active receptors / tcp-connections.
--dendrite.requires_grad

• If true, the dendrite passes gradients on the wire.
--dendrite.no_requires_grad

• If set, the dendrite will not passes gradients on the wire.
--dendrite.multiprocessing
dendrite.multiprocessing:
BT_DENDRITE_MULTIPROCESSING

• If set, the dendrite will initialize multiprocessing.
--dendrite.compression
dendrite.compression:

• Which compression algorithm to use for compression (gzip, deflate, NoCompression).
--dendrite._mock
dendrite._mock:

• To turn on dendrite mocking for testing purposes.

## Subtensor

--subtensor.network
subtensor.network:
BT_SUBTENSOR_NETWORK

• The Subtensor network (nobunaga/nakamoto/local).
--subtensor.chain_endpoint
subtensor.chain_endpoint:
BT_SUBTENSOR_CHAIN_ENDPOINT

• The Subtensor endpoint. If set, overrides subtensor.network.
--subtensor._mock
BT_SUBTENSOR_MOCK

• To turn on Subtensor mocking for testing purposes.

## Logging

--logging.debug
logging.debug:
BT_LOGGING_DEBUG

• Turn on Bittensor debugging information.
--logging.trace
logging.trace:
BT_LOGGING_TRACE

• Turn on Bittensor trace level information.
--logging.record_log
logging.record_log:
BT_LOGGING_RECORD_LOG

• Turns on logging to file.
--logging.logging_dir
logging.logging_dir:
BT_LOGGING_LOGGING_DIR

• Logging default root directory.

## Dataset

--dataset.batch_size
dataset.batch_size:
BT_DATASET_BATCH_SIZE

• Batch size.
--dataset.block_size
dataset.block_size:
BT_DATASET_BLOCK_SIZE

• Number of text items to pull for each example.
--dataset.num_workers
dataset.num_workers:
BT_DATASET_NUM_WORKERS

• Number of workers for data loader.
--dataset.dataset_name
dataset.dataset_name:
BT_DATASET_DATASET_NAME

• Which datasets to use (ArXiv, BookCorpus2, Books3, DMMathematics, EnronEmails, EuroParl, Gutenberg_PG, HackerNews, NIHExPorter, OpenSubtitles, PhilPapers, UbuntuIRC, YoutubeSubtitles).
--dataset.data_dir
dataset.data_dir:

• Where to save and load the data.
--dataset.save_dataset
dataset.save_dataset:
BT_DATASET_SAVE_DATASET

--dataset.max_datasets
dataset.max_datasets:
BT_DATASET_MAX_DATASETS

• Number of datasets to load.
--dataset.num_batches
dataset.num_batches:
BT_DATASET_NUM_BATCHES

• The number of data to download each time (measured by the number of batches).
--dataset._mock
dataset._mock:

• To turn on dataset mocking for testing purposes.

## Metagraph

--metagraph._mock

• To turn on metagraph mocking for testing purposes.

## Nucleus

--nucleus.topk

• The number of peers queried during each remote forward call.
--nucleus.nhid

• The dimension of the feedforward network model in nn.TransformerEncoder.
--nucleus.nhead

--nucleus.nlayers

• The number of nn.TransformerEncoderLayer in nn.TransformerEncoder.
--nucleus.dropout

• The dropout value.
--nucleus.importance

• Hyperparameter for the importance loss.
--nucleus.noise_multiplier

• Standard deviation multiplier on weights.

## CUDA

--cuda

• Uses CUDA for registration.
--cuda.dev_id

• Which GPU to use for registration.
--cuda.TPB

• The number of threads per block in the CUDA kernel. This should be left at the default 256 or raised to 512. The registration process may crash if this is set too high. Only set to powers of 2.
--cuda.update_interval

• The number of nonces to solve between chain updates. Default setting is 50_000. Setting to a higher value may mean less frequent chain updates, which may lead to submitting a solution outside of the valid solve window for that block (not efficient). Avoid setting this above 80_000.

## Wandb

--wandb.api_key
wandb.api_key:

• Pass Wandb api key.
--wandb.directory
wandb.directory:
BT_WANDB_DIRECTORY

• Pass Wandb run name.
--wandb.name
wandb.name:
BT_WANDB_NAME

• Pass Wandb name.
--wandb.offline
wandb.offline:
BT_WANDB_OFFLINE

• Pass Wandb offline option.
--wandb.project
wandb.project:
BT_WANDB_PROJECT

• Pass Wandb project name.
--wandb.run_group
wandb.run_group:
BT_WANDB_RUN_GROUP

• Pass Wandb group name.
--wandb.tags
wandb.tags:
BT_WANDB_TAGS

• Pass Wandb tags.

# Return Codes

The following return codes from backward and forward calls can be used for diagnosing your miner:

NoReturn = 0; Default value.

Success = 1; Succesfull query.

Timeout = 2; Request timeout.

Backoff = 3; Call triggered a backoff.

Unavailable = 4; Endpoint not available.

NotImplemented = 5; Modality not implemented.

EmptyRequest = 6; Request is empty.

EmptyResponse = 7; Response is empty.

InvalidResponse = 8; Request is invalid.

InvalidRequest = 9; Response is invalid.

RequestShapeException = 10; Request has an invalid shape.

ResponseShapeException = 11; Response has an invalid shape.

RequestSerializationException = 12; Request failed to serialize.

ResponseSerializationException = 13; Response failed to serialize.

RequestDeserializationException = 14; Request failed to deserialize.

ResponseDeserializationException = 15; Response failed to deserialize.

NotServingNucleus = 16; Receiving Neuron is not serving a Nucleus to query.

NucleusTimeout = 17; Processing on the Server side timed out.

NucleusFull = 18; Returned when the processing queue on the Server is full.

RequestIncompatibleVersion = 19; The request handler is incompatible with the request version. Request from Validator to Server.

ResponseIncompatibleVersion = 20; The request handler is incompatible with the request version. Response from Server to Validator.

SenderUnknown = 21; Requester is not known by the receiver.

UnknownException = 22; Unknown exception.

Unauthenticated = 23; Authentication failed.

Validator HyperparameterValue
BlocksPerStep100
BondsMovingAverage900,000
ImmunityPeriod3072
IncentivePruningDenominator1
Kappa2
MaxAllowedMaxMinRatio64
MaxAllowedUids4096
MinAllowedWeights1024
Rho10
StakePruningDenominator20
StakePruningMin1024
TargetRegistrationsPerInterval2
ValidatorBatchSize32
ValidatorEpochLen250
ValidatorEpochsPerReset60
ValidatorSequenceLength256
ValidatorExcludeQuantile5
ScalingLawPower50
SynergyScalingLawPower50
MaxWeightLimit17_179_868

• The interval over which we calculate the rate of new peer registrations, if the rate exceeds TargetRegistrationsPerInterval then the POW difficulty is doubled.

## BlocksPerStep

• The number of blocks which pass between a recalculation of incentive terms: Rank, Trust, Consensus, Incentive, Dividends, Emissions, the distribution of newly minted stake, and the calculation of the next bond matrix.

## BondsMovingAverage

• The coefficient α representing the smoothing factor during the computation of the new Bonds matrix via an exponentially weighted moving average.

## ImmunityPeriod

• How many blocks a a hotkey is immune from deregistration after joining the network.

## IncentivePruningDenominator

• Works together with the StakePruningDenominator to determine the ratio between stake and incentive for a minimum bound of score to keep a hotkey registered.

## Kappa

• The temperature of sigmoid activation function to regularize Trust and become Consensus.

## MaxAllowedMaxMinRatio

• Sets the ratio between the highest weight and lowest weight a Validator can set in one weight setting. This influences the reward skew.

## MaxAllowedUids

• How many UIDs can be registered to the network at one time.

## MinAllowedWeights

• The lower limit on the number of non zero weights a Validator sets after each epoch. Increasing MinAllowedWeights increases the size of the consensus set: the number of peers with greater than 50% trust.

## StakePruningDenominator

• works together with the incentivePruningDenominator, to determine the ratio between stake and incentive for a minimum bound of score to keep a hotkey registered.

## StakePruningMin

• The threshold value which separates Servers from Validators during a pruning operation. Miners with stake greater than stakePruningMin are not pruned based on incentive.

## TargetRegistrationsPerInterval

• The target number of registrations expected each block. If the number of registrants is greater than TargetRegistrationsPerInterval, the difficulty of the registration will double. If the number of registrants is less than TargetRegistrationsPerInterval, the difficulty of the registration will be halved.

## ValidatorBatchSize

• Determines the size of each validation request sent by Validators. Each validation request has consistent state [batch size, sequence length]. Increasing batch sizes forces increased load onto Servers forcing them to improve hardware.

## ValidatorEpochLength

• Determines the number of blocks per epoch for each Validator. This parameter controls how often each Validator will set its weights.

## ValidatorEpochsPerReset

• When active, Validators can reset their local scoring storage and start scoring without previous history.

## ValidatorSequenceLength

• Determines the size of each validation request sent by Validators. Each validation request has a consistent state [batch size, sequence length]. Increasing sequence length forces increased load onto Servers forcing them to improve hardware.

## ValidatorExcludeQuantile

• Validators exclude from weight setting the lowest quantile or percentile performing Servers recorded locally.

## ScalingLawPower

• Adjusts through a power coefficient the estimated number of model parameters.

## SynergyScalingLawPower

• Adjusts through a power coefficient the estimated number of model parameters due to synergy.

## MaxWeightLimit

• The maximum weight a Validator is allowed to set on a Server.