Merge release/7.0.0

Author: HudsonGraeme

README.md

@@ -50,6 +50,8 @@ btcli subnet register --subtensor.network finney --netuid 2 --wallet.name {your_
 
 ### Run the miner
 
+<details>
+<summary>Docker Instructions (not supported during the competition running from Feb 6 - Apr 20)</summary>
 #### With docker compose (recommended)
 
 ```yaml
@@ -96,36 +98,30 @@ docker run -d \
   --wallet.hotkey {your_miner_hotkey_name} \
   --netuid 2
 ```
+</details>
 
 #### With pm2
 
 > [!IMPORTANT]
-> Ensure you are within the `/neurons` directory before using the commands below to start your miner
+> Ensure you are within the `./neurons` directory before using the commands below to start your miner
 >
 > ```console
 > cd neurons
 > ```
 
-##### Within a virtual environment
-
 ```console
-pm2 start miner.py --name miner --interpreter ../omron-venv/bin/python --kill-timeout 3000 -- \
+pm2 start miner.py --name miner --interpreter ../.venv/bin/python --kill-timeout 3000 -- \
 --netuid 2 \
 --wallet.name {your_miner_key_name} \
 --wallet.hotkey {your_miner_hotkey_name}
 ```
 
-##### Outside of a virtual environment
-
-```console
-pm2 start miner.py --name miner --interpreter python3 --kill-timeout 3000 -- \
-  --netuid 2 \
-  --wallet.name {your_miner_key_name} \
-  --wallet.hotkey {your_miner_hotkey_name}
-```
+Or run this command with `make pm2-miner WALLET_NAME={your_miner_key_name} HOTKEY_NAME={your_miner_hotkey_name}`
 
 ### Run the validator
 
+<details>
+<summary>Docker Instructions (not supported during the competition running from Feb 6 - Apr 20)</summary>
 #### With docker compose (recommended)
 
 ```yaml
@@ -174,38 +170,33 @@ docker run -d \
   --wallet.hotkey {validator_hot_key_name} \
   --netuid 2
 ```
+</details>
 
 #### With pm2
 
 > [!IMPORTANT]
-> Ensure you are within the `/neurons` directory before using the commands below to start your validator
+> Ensure you are within the `./neurons` directory before using the commands below to start your validator
 >
 > ```console
 > cd neurons
 > ```
 
-##### Within a virtual environment
-
 ```console
-pm2 start validator.py --name validator --interpreter ../omron-venv/bin/python --kill-timeout 3000 -- \
+pm2 start validator.py --name validator --interpreter ../.venv/bin/python --kill-timeout 3000 -- \
 --netuid 2 \
---wallet.name {validator_key_name} \
---wallet.hotkey {validator_hot_key_name}
+--wallet.name {your_validator_key_name} \
+--wallet.hotkey {your_validator_hotkey_name}
 ```
 
-##### Outside of a virtual environment
-
-```console
-pm2 start validator.py --name validator --interpreter python3 --kill-timeout 3000 -- \
-  --netuid 2 \
-  --wallet.name {validator_key_name} \
-  --wallet.hotkey {validator_hot_key_name}
-```
+Or run this command with `make pm2-validator WALLET_NAME={validator_key_name} HOTKEY_NAME={validator_hot_key_name}`
 
 ## Miner
 
 Miners contribute to this subnet by providing compute to generate output from, and prove AI model inferences. Miners receive workloads from validators in the form of input data, perform verified inferences on those inputs and respond with output along with a zero knowledge proof of inference.
 
+> [!IMPORTANT]
+> As of February 2025, the miner **should** be run on a bare-metal MacOS machine with support for Metal GPU acceleration, to optimize for performance.
+
 ### Hardware requirements
 
 #### Minimum
@@ -238,23 +229,29 @@ Validators are responsible for verifying model outputs as provided by miners, an
 
 ### Hardware requirements
 
+> [!IMPORTANT]
+> As of February 2025, the validator **must** be run on a bare-metal MacOS machine with support for Metal GPU acceleration.
+
+Though AWS instances for metal are recommended, any MacOS machine with a Metal GPU is sufficient.
+
 #### Minimum
 
-| Component    | Requirement   |
-| ------------ | ------------- |
-| CPU          | 8 core 3.2GHz |
-| RAM          | 16GB          |
-| Network Up   | 400Mbps       |
-| Network Down | 400Mbps       |
-| Storage      | 1TB           |
+| Component    | Requirement            |
+| ------------ | ---------------------- |
+| Instance     | mac2-m2pro.metal (AWS) |
+| CPU          | Apple M2 Pro (12-core) |
+| RAM          | 32GB                   |
+| Network Up   | 10Gbps                 |
+| Network Down | 10Gbps                 |
+| Storage      | 2TB SSD                |
 
 #### Recommended
 
-| Component      | Recommendation |
-| -------------- | -------------- |
-| CPU            | 8 core 3.4GHz  |
-| RAM            | 32GB           |
-| Network Up     | 1+Gbps         |
-| Network Down   | 1+Gbps         |
-| Storage        | 2+TB           |
-| Storage Medium | SSD            |
+| Component    | Recommendation           |
+| ------------ | ------------------------ |
+| Instance     | mac2-m1ultra.metal (AWS) |
+| CPU          | Apple M1 Ultra (20-core) |
+| RAM          | 128GB                    |
+| Network Up   | 10Gbps                   |
+| Network Down | 10Gbps                   |
+| Storage      | 2TB+ SSD                 |

competition_circuit/.gitkeep

@@ -21,7 +21,7 @@ The below arguments are specific to miner software and have no effect on validat
 
 | Argument              | Required | Default | Accepted Values | Description                                                  |
 | --------------------- | :------: | ------- | --------------- | ------------------------------------------------------------ |
-| `--disable-blacklist` |    No    | `False` | `True`, `False` | Disables request filtering and allows all incoming requests. |
+| `--disable-blacklist` |    No    | `False` | `True`, `False` | Disables request filtering and allows all incoming requests.  |
 
 ### Validator specific arguments
 
@@ -37,6 +37,7 @@ The below arguments are specific to validator software and have no effect on min
 | `--external-api-workers`              |    No    | `1`       | Integer         | The number of workers for the validator's external API.                                                                                                                                     |
 | `--external-api-host`                 |    No    | `0.0.0.0` | String          | The host for the validator's external API.                                                                                                                                                  |
 | `--do-not-verify-external-signatures` |    No    | `False`   | `True`, `False` | External PoW requests are signed by validator's (sender's) wallet. By default, these are checked to ensure legitimacy. This should only be disabled in controlled development environments. |
+| `--competition-sync-interval`         |    No    | `86400`   | Integer         | The interval for syncing the competition in seconds. Defaults to 86400 (1 day).                                                                                                             |
 | `--prometheus-monitoring`             |    No    | `False`   | `True`, `False` | Whether to enable sering of metrics for Prometheus monitoring.                                                                                                                              |
 | `--prometheus-port`                   |    No    | `9090`    | Integer         | The port for the Prometheus data source.                                                                                                                                                    |
 | `--serve-axon`                        |    No    | `False`   | `True`, `False` | Whether to serve the axon displaying your API information.                                                                                                                                  |
@@ -66,8 +67,8 @@ Bittensor subtensor configuration options.
 
 | Argument                     | Required | Default            | Accepted Values                      | Description                                                                                                                |
 | ---------------------------- | :------: | ------------------ | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
-| `--subtensor.network`        |    No    | `finney`           | `finney`, `test`, `archive`, `local` | The subtensor network to connect to. Overrides `--subtensor.chain_endpoint` with a default node from the selected network. |
-| `--subtensor.chain_endpoint` |    No    | Depends on network | String                               | The specific blockchain endpoint to connect to. Overrides the network default endpoint if set.                             |
+| `--subtensor.network`        |    No    | `finney`           | `finney`, `test`, `archive`, `local`   | The subtensor network to connect to. Overrides `--subtensor.chain_endpoint` with a default node from the selected network. |
+| `--subtensor.chain_endpoint` |    No    | Depends on network | String                               | The specific blockchain endpoint to connect to. Overrides the network default endpoint if set.                              |
 | `--subtensor._mock`          |    No    | `False`            | `True`, `False`                      | If true, uses a mocked connection to the chain for testing purposes.                                                       |
 
 ### Axon
@@ -82,7 +83,6 @@ Bittensor Axon configuration options.
 | `--axon.ip`            |    No    | `[::]`  | String          | The local IP this axon binds to.                                                          |
 | `--axon.external_port` |    No    | None    | Integer         | The public port this axon broadcasts to the network.                                      |
 | `--axon.external_ip`   |    No    | None    | String          | The external IP this axon broadcasts to the network.                                      |
-| `--axon.max_workers`   |    No    | 10      | Integer         | The maximum number of connection handler threads working simultaneously on this endpoint. |
 
 ### Logging
 
@@ -94,5 +94,5 @@ Bittensor logging configuration options.
 | ----------------------- | :------: | -------------------- | --------------- | ------------------------------------------ |
 | `--logging.debug`       |    No    | `False`              | `True`, `False` | Turn on bittensor debugging information.   |
 | `--logging.trace`       |    No    | `False`              | `True`, `False` | Turn on bittensor trace level information. |
-| `--logging.record_log`  |    No    | `False`              | `True`, `False` | Turns on logging to file.                  |
+| `--logging.record_log`  |    No    | `False`              | `True`, `False` | Turns on logging to file.                   |
 | `--logging.logging_dir` |    No    | `~/.bittensor/logs/` | String          | Logging default root directory.            |

docs/command_line_arguments.md

@@ -0,0 +1,82 @@
+# Omron Competitions Framework
+
+🥩 **Competitions Overview**
+Omron's competition system drives innovation in zkML performance by creating structured challenges where miners optimize circuits for specific tasks. Competitions leverage Omron's Proof-of-Inference mechanism([1](https://docs.omron.ai/intro-to-omron)) to verify miner submissions while maintaining computational integrity.
+
+## Competition Lifecycle
+
+### Phases
+
+1. **Pending**
+
+   - Competition scheduled but not yet active
+   - Baseline model and evaluation criteria published
+   - Miners prepare circuits using competition template
+
+2. **Active**
+
+   - Open submission period (typically 7-14 days)
+   - Real-time leaderboard tracking
+   - Continuous circuit evaluation
+
+3. **Completed**
+
+   - Final scores calculated
+   - Rewards distributed
+   - SOTA circuit preserved for future benchmarking
+
+4. **Inactive**
+   - Between competition periods
+   - Historical data analysis
+   - Preparation for next challenge
+
+## Miner Participation
+
+### Requirements
+
+- Submit optimized zk-circuits matching competition template
+- Meet minimum hardware specs([2](https://docs.omron.ai/miner-validator-resources))
+
+### Submission Process
+
+1. Clone competition circuit template
+2. Optimize model while maintaining I/O spec
+3. Generate verification artifacts:
+   - `settings.json
+   - `model.compiled`
+   - `vk.key`
+   - `pk.key`
+4. Commit circuit to the blockchain
+
+## Evaluation Criteria
+
+| Metric        | Weight | Description                         |
+| ------------- | ------ | ----------------------------------- |
+| Accuracy      | 40%    | Output similarity vs baseline model |
+| Proof Size    | 30%    | Byte size of generated ZK proofs    |
+| Response Time | 30%    | End-to-end proof generation latency |
+
+> [!CAUTION]
+> Should any proofs fail to verify, the miner will be assigned a zero score.
+
+## Competition Management
+
+### Key Features
+
+- Automatic state transitions
+- Real-time metrics tracking
+- Fraud detection via proof verification
+
+### Monitoring
+
+- WandB integration for performance tracking
+- Public leaderboard on Omron dashboard
+- Daily score snapshots
+
+## Risks
+
+- Invalid proofs result in immediate disqualification
+- Late submissions not accepted after end timestamp
+
+**Links**
+[Technical Roadmap](https://docs.omron.ai/technical-roadmap) • [Miner Setup](https://docs.omron.ai/miner-validator-resources) • [zkML Documentation](https://docs.omron.ai/custom_circuit_integrations)

docs/competitions.md

@@ -14,12 +14,14 @@ Run the following command to start a miner on mainnet
 
 ```console
 cd neurons
-pm2 start miner.py --name miner --interpreter python3 -- \
+pm2 start miner.py --name miner --interpreter ../.venv/bin/python -- \
 --netuid 2 \
 --wallet.name {your_miner_key_name} \
 --wallet.hotkey {your_miner_hotkey_name}
 ```
 
+Or run this command with `make pm2-miner WALLET_NAME={your_miner_key_name} HOTKEY_NAME={your_miner_hotkey_name}`
+
 [View all acceptable CLI arguments →]
 
 ## Validating
@@ -28,12 +30,14 @@ Run the following command to start a validator on mainnet
 
 ```console
 cd neurons
-pm2 start validator.py --name validator --interpreter python3 -- \
+pm2 start validator.py --name validator --interpreter ../.venv/bin/python -- \
 --netuid 2 \
 --wallet.name {your_validator_key_name} \
 --wallet.hotkey {your_validator_hotkey_name}
 ```
 
+Or run this command with `make pm2-validator WALLET_NAME={validator_key_name} HOTKEY_NAME={validator_hot_key_name}`
+
 [View all acceptable CLI arguments →]
 
 [View all acceptable CLI arguments →]: ./command_line_arguments.md

docs/running_on_mainnet.md

@@ -2,6 +2,9 @@
 
 This tutorial will guide you through setting up a local subtensor chain, creating a subnetwork, and connecting your mechanism to it.
 
+> [!TIP]
+> The devcontainer provided in this repository already takes care of everything in this tutorial for you.
+
 ### 1. Install substrate dependencies
 
 Begin by installing the required dependencies for running a substrate node.

docs/running_on_staging.md

@@ -14,13 +14,15 @@ Run the following command to start a miner on testnet
 
 ```console
 cd neurons
-pm2 start miner.py --name miner --interpreter python3 -- \
+pm2 start miner.py --name miner --interpreter ../.venv/bin/python -- \
 --netuid 118 \
 --wallet.name {your_miner_key_name} \
 --wallet.hotkey {your_miner_hotkey_name} \
 --subtensor.network test
 ```
 
+Or run this command with `make pm2-test-miner WALLET_NAME={your_miner_key_name} HOTKEY_NAME={your_miner_hotkey_name}`
+
 [View all acceptable CLI arguments →]
 
 ## Validating
@@ -29,13 +31,15 @@ Run the following command to start a validator on testnet
 
 ```console
 cd neurons
-pm2 start validator.py --name validator --interpreter python3 -- \
+pm2 start validator.py --name validator --interpreter ../.venv/bin/python -- \
 --netuid 118 \
 --wallet.name {your_validator_key_name} \
 --wallet.hotkey {your_validator_hotkey_name} \
 --subtensor.network test
 ```
 
+Or run this command with `make pm2-test-validator WALLET_NAME={validator_key_name} HOTKEY_NAME={validator_hot_key_name}`
+
 [View all acceptable CLI arguments →]
 
 [View all acceptable CLI arguments →]: ./command_line_arguments.md

docs/running_on_testnet.md

@@ -100,3 +100,49 @@ test-validator:
 		--wallet.hotkey $(WALLET_HOTKEY) \
 		--netuid 118 \
 		--subtensor.network test
+
+pm2-setup:
+	INSTALL_PATH="." ./setup.sh
+
+pm2-stop:
+	pm2 stop omron-miner || true
+	pm2 stop omron-validator || true
+
+pm2-miner:
+	uv sync --locked --no-dev
+	cd neurons; \
+	pm2 start miner.py --name omron-miner --interpreter ../.venv/bin/python --kill-timeout 3000 -- \
+	--wallet.path $(WALLET_PATH) \
+	--wallet.name $(WALLET_NAME) \
+	--wallet.hotkey $(WALLET_HOTKEY) \
+	--netuid $(NETUID)
+
+pm2-validator:
+	uv sync --locked --no-dev
+	cd neurons; \
+	pm2 start validator.py --name omron-validator --interpreter ../.venv/bin/python --kill-timeout 3000 -- \
+	--wallet.path $(WALLET_PATH) \
+	--wallet.name $(WALLET_NAME) \
+	--wallet.hotkey $(WALLET_HOTKEY) \
+	--netuid $(NETUID)
+
+pm2-test-miner:
+	uv sync --locked --no-dev
+	cd neurons; \
+	pm2 start miner.py --name omron-miner --interpreter ../.venv/bin/python --kill-timeout 3000 -- \
+	--wallet.path $(WALLET_PATH) \
+	--wallet.name $(WALLET_NAME) \
+	--wallet.hotkey $(WALLET_HOTKEY) \
+	--netuid 118 \
+	--subtensor.network test \
+	--disable-blacklist
+
+pm2-test-validator:
+	uv sync --locked --no-dev
+	cd neurons; \
+	pm2 start validator.py --name omron-validator --interpreter ../.venv/bin/python --kill-timeout 3000 -- \
+	--wallet.path $(WALLET_PATH) \
+	--wallet.name $(WALLET_NAME) \
+	--wallet.hotkey $(WALLET_HOTKEY) \
+	--netuid 118 \
+	--subtensor.network test