Skip to main content

Openvalidators is a collection of open source validators for the Bittensor Network.

Project description

Open Validators

Discord Chat PyPI version License: MIT


This repository contains Bittensor Validators designed by the OpenTensor Foundation team for the community. It offers several functionalities, such as:

  • Building and running Bittensor validators
  • Real-time analysis of validator performance integrated with wandb
  • Offline analysis of data generated from the network
  • Creation of datasets using network data for training miners

The main goal of this repository is to facilitate the interaction with the Bittensor network by providing a set of open-source validators to the community. The current validator implementation queries the network for responses and evaluations using carefully crafted prompts, that are later evaluated by a large foundation GPT-J reward model.

Additionally, the repository provides an analysis and data toolkit that allows users to analyze the data generated from the validator's interaction with the network. By default, the validator collects various data points, such as question responses, evaluations, rewards and scorings by UID, and model performance data. This data is then sent to wandb, making it publicly accessible to the community.

The toolkit also includes scripts to analyze and extract data from specific validator runs or multiple runs, simplifying the creation of valuable datasets for the community's miners.

To learn more about the Bittensor validation process, check out this documentation.

Usage

There are currently four main avenues for engaging with this repository:

  1. Validators:

    • Designed for TAO holders who aim to build or run validators developed by the foundation.
  2. Real-time monitoring with wandb integration:

    • Allows users to analyze the performance of various validators runs in real-time using wandb.
  3. Network analysis

    • Caters to individuals, researchers, and data scientists interested in analyzing the data generated from the validators' interaction with the Bittensor network.
  4. Dataset creation

    • Serves individuals, researchers, and developers who seek to create datasets for the community's miners.

Install

There are two ways to use OpenTensor validators:

  1. With pip:
$ pip3 install openvalidators
  1. From source:
$ git clone https://github.com/opentensor/validators.git
$ pip3 install -e openvalidators/

You can test the installation by running the following command:

$ python3 validators/openvalidators/neuron.py --help

Validators

Participation in Network Validation is available to TAO holders. The validation mechanism utilizes a dual proof-of-stake and proof-of-work system known as Yuma Consensus, which you can learn more about here. To start validating, you will need to have a Bittensor wallet with a sufficient amount of TAO tokens staked.

Once you have your wallet ready for validation, you can start the foundation validator by running the following command:

$ python3 validators/openvalidators/neuron.py --wallet.name <your-wallet-name> --wallet.hotkey <your-wallet-hot-key>

Real-time monitoring with wandb integration

By default, the validator sends data to wandb, allowing users to monitor running validators and access key metrics in real time, such as:

  • Gating model loss
  • Hardware usage
  • Forward pass time
  • Block duration

All the data sent to wandb is publicly available to the community at the following link.

You don't need to have a wandb account to access the data or to generate a new run, but bear in mind that data generated by anonymous users will be deleted after 7 days as default wandb policy.

Network analysis

This repository provides a set of tools to analyze the data generated by the validators, including:

A basic tutorial for downloading and analyzing wandb data can be found in analysis.

Dataset creation

For the individuals who are eager to create datasets tailored specifically for the community's miners. With convenient scripts available in the scripts folder, you can effortlessly download data from specific or multiple runs of wandb, empowering you to curate comprehensive and valuable datasets that align with your mining objectives. Check the README of the data collector for more information.


Experimental Features

Prompt-Based Scoring

The reward mechanism for miner completions plays a crucial role in the overall quality of the network. As such, we are constantly developing and testing new methods that make the reward process open and robust. This benefits everyone. Presently, miners weights are set based on evaluations of their completions that are carried out by a reward model. This presents two major challenges:

  1. Reward model evaluations are a bottleneck, owing to the large model size
  2. Reward models are vulnerable to attacks, which reduces the network quality for everyone

Consequently, validators also perform shadow scoring, which outsources the reward mechanism to the network. This feature is currently under development, and so the prompt-based scores are only used for research purposes.

Sentence Embedding Gating Model

Another cornerstone of the validator functionality is the use of a mixture of experts (MoE) model, which we call the gating model, to enable queries to be efficiently routed to the best-suited miners. This incentivizes miners to become specialists, which in turn improves response quality. It also reduces latency and addresses bandwidth issues in the network. We are working on a new and improved gating model, based on sentence embeddings, which is expected to be a more powerful and robust router for queries. By default it is disabled, but can be enabled with the flags

--neuron.use_custom_gating_model --gating.model_name sentence-transformers/all-distilroberta-v1

License

The MIT License (MIT) Copyright © 2023 Yuma Rao

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openvalidators-1.0.4.tar.gz (28.0 kB view details)

Uploaded Source

Built Distribution

openvalidators-1.0.4-py3-none-any.whl (37.7 kB view details)

Uploaded Python 3

File details

Details for the file openvalidators-1.0.4.tar.gz.

File metadata

  • Download URL: openvalidators-1.0.4.tar.gz
  • Upload date:
  • Size: 28.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for openvalidators-1.0.4.tar.gz
Algorithm Hash digest
SHA256 79939b2d977850addbd29e3b6bbe35b9ba7059bae6b7d591f6ce9330947c3c01
MD5 1caedd7c52270e11fef401079d1cf962
BLAKE2b-256 98f04365237c9e839a9ec0cecf774b64b542c0479d064fc60a2f3e99d4e27c8e

See more details on using hashes here.

File details

Details for the file openvalidators-1.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for openvalidators-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 af26acab2c26c81f69825257e0ab86ab467336f4eb746f8039389557882104b3
MD5 6707d182e33682f2df57e040dbfb99d6
BLAKE2b-256 a1abab6ae423f046fc6b3d19a0893e0fc8fbdd546d1f30294197fb7bb2cb86cd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page