Features/modular (opentensor#26)

* WIP refactor for improved workflow abstracitons

* Add WIP test and debug validator forward

* get miner working

* (almost) get validator working

* validator working

* black formatter

* docstrings

* tests (WIP)

* Remove rewards and unncessary imports. Update forward docstrings

* Add axon. Minor reordering and some docstring cleanup

* Add miner todo for saving state

* Black

* Restructure config to separate miner and validator specific args

* Black

* Change starting scores from ones to zeros

* Features/more modular (opentensor#27)

* Create BaseNeuron class, which takes care of common operations between miner and validator neurons. Also move everything in sync.py to the respective neuron classes and delete

* And removes pylint swiftly afterwards

* Features/cleanup modular (opentensor#31)

* Cleanup docs and remove spec version so that these files do not need to be modified by developers

* Further docstring improvements and set spec version as an attribute to be used when setting weights

* Add license and some docstring improvements

* Update README to contain correct TODO files, add note to developer to rename template directory and enforce consistent TODO comments throughout files

* Black

* Fix imports and logging. Move blacklist and priority abstractmethods to BaseMinerNeuron so that validators do not need to define them;

* pylint on major errors, black 79 line limit

* run black with 79 line length

* update neuron child class names

* add spec version as a member of BaseNeuron

* don't set_weights on init and add load_state()

* add proper enter/exit, don't delete axon, save/load state for vali

* handle spec version in base class

* set epoch length default 0->5, check if should exit in validator run

* don't save/load block, load state in validator init as hint

* black

* Change epoch length to 100

---------

Co-authored-by: ifrit98 <[email protected]>

---------

Co-authored-by: Steffen Cruz <[email protected]>

Author: ifrit98

.circleci/config.yml

@@ -40,7 +40,31 @@ jobs:
           name: Black format check
           command: |
             . env/bin/activate
-            python -m black --exclude '(env|venv|.eggs)' --check .
+            black --line-length 79 --exclude '(env|venv|.eggs)' --check .
+
+  pylint:
+    resource_class: small
+    parameters:
+      python-version:
+        type: string
+    docker:
+      - image: cimg/python:<< parameters.python-version >>
+
+    steps:
+      - checkout
+
+      - run:
+          name: Install Pylint
+          command: |
+            python -m venv env/
+            . env/bin/activate
+            pip install pylint
+
+      - run:
+          name: Pylint check
+          command: |
+            . env/bin/activate
+            pylint --fail-on=W,E,F --exit-zero  ./
 
   check_compatibility:
     parameters:
@@ -131,11 +155,13 @@ workflows:
       - check_compatibility:
           python_version: "3.11"
           name: check-compatibility-3.11
-  
+
   pr-requirements:
     jobs:
       - black:
           python-version: "3.8.12"
+      - pylint:
+          python-version: "3.8.12"
       - build:
           matrix:
             parameters:

.gitignore

@@ -158,3 +158,5 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+testing/

README.md

@@ -28,6 +28,7 @@ This template contains all the required installation instructions, scripts, and
 - Building Bittensor subnets.
 - Creating custom incentive mechanisms and running these mechanisms on the subnets. 
 
+In order to simplify the building of subnets, this template abstracts away the complexity of the underlying blockchain and other boilerplate code. While the default behavior of the template is sufficient for a simple subnet, you should customize the template in order to meet your specific requirements.
 ---
 
 ## Introduction
@@ -81,7 +82,18 @@ As described in [Quickstarter template](#quickstarter-template) section above, w
 - `template/protocol.py`: Contains the definition of the wire-protocol used by miners and validators.
 - `neurons/miner.py`: Script that defines the miner's behavior, i.e., how the miner responds to requests from validators.
 - `neurons/validator.py`: This script defines the validator's behavior, i.e., how the validator requests information from the miners and determines the scores.
-
+- `template/forward.py`: Contains the definition of the validator's forward pass.
+- `template/reward.py`: Contains the definition of how validators reward miner responses.
+
+In addition to the above files, you should also update the following files:
+- `README.md`: This file contains the documentation for your project. Update this file to reflect your project's documentation.
+- `CONTRIBUTING.md`: This file contains the instructions for contributing to your project. Update this file to reflect your project's contribution guidelines.
+- `template/__init__.py`: This file contains the version of your project.
+- `setup.py`: This file contains the metadata about your project. Update this file to reflect your project's metadata.
+- `docs/`: This directory contains the documentation for your project. Update this directory to reflect your project's documentation.
+
+__Note__
+The `template` directory should also be renamed to your project name.
 ---
 
 ## License

contrib/CONTRIBUTING.md

@@ -16,10 +16,10 @@ The following is a set of guidelines for contributing to the Bittensor ecosystem
 
 
 ## How Can I Contribute?
-TODO[owner]: Define your desired contribution procedure.
+TODO(developer): Define your desired contribution procedure.
 
 ## Communication Channels
-TODO[owner]: Place your communication channels here
+TODO(developer): Place your communication channels here
 
 > Please follow the Bittensor Subnet [style guide](./STYLE.md) regardless of your contribution type. 
 
@@ -99,7 +99,7 @@ After you submit a pull request, it will be reviewed by the maintainers. They ma
 > Note: Be sure to merge the latest from "upstream" before making a pull request:
 
 ```bash
-git remote add upstream https://github.com/opentensor/bittensor.git # TODO[owner]: replace with your repo URL
+git remote add upstream https://github.com/opentensor/bittensor.git # TODO(developer): replace with your repo URL
 git fetch upstream
 git merge upstream/<your-branch-name>
 git push origin <your-branch-name>

docs/running_on_mainnet.md

@@ -29,7 +29,7 @@ After installing `bittensor`, proceed as below:
 
 ```bash
 # In your project directory
-git clone https://github.com/opentensor/bittensor-subnet-template.git # TODO[owner]: Replace this with your custom repo URL
+git clone https://github.com/opentensor/bittensor-subnet-template.git # TODO(developer): Replace this with your custom repo URL
 cd bittensor-subnet-template # Enter your subnet template repo directory
 python -m pip install -e . # Install your subnet template package
 ```