Skip to content

Commit

Permalink
readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
peterc-yuma committed Jan 6, 2025
1 parent 8e0e4b6 commit 3853873
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 6 deletions.
15 changes: 15 additions & 0 deletions .env.validator.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Network Configuration
NETWORK=localnet # Options: localnet, testnet, finney

# Wallet Configuration
COLDKEY=validator
VALIDATOR_HOTKEY=default

# Node Configuration
VALIDATOR_NAME=validator
VALIDATOR_PORT=8091
AXON_IP=127.0.0.1
AXON_EXTERNAL_IP=127.0.0.1

# Logging
LOGGING_LEVEL=info # Options: info, debug, trace
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ ifeq ($(NETWORK),localnet)
else ifeq ($(NETWORK),testnet)
netuid = 256
else ifeq ($(NETWORK),finney)
netuid = 64
#netuid = 64
$(error Finney network not supported yet)
endif

metagraph:
Expand Down
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ cd precog

Create and source a python virtual environment:
```
python3 -m venv
python3 -m venv .venv
source .venv/bin/activate
```

Expand All @@ -71,7 +71,7 @@ poetry install
## Configuration

### Makefile
Start by editing the Makefile with you wallet and network information:
Start by editing the Makefile with your wallet and network information:
```
################################################################################
# User Parameters #
Expand All @@ -83,6 +83,21 @@ netuid = $(testnet_netuid)
network = $(testnet)
```

### .env Files
Copy the example `.env` files and edit all desired values:

#### .env.validator
```
cp .env.validator.example .env.validator
```
Edit `.env.validator` with your desired values.

#### .env.miner
```
cp .env.miner.example .env.miner
```
Edit `.env.miner` with your desired values.

### Wandb
Wandb integration is planned for mainnet launch and does not currently work.

Expand All @@ -93,7 +108,7 @@ Wandb integration is planned for mainnet launch and does not currently work.
Base miner:
1. Run the command:
```
make miner
make miner ENV_FILE=.env.miner
```
Custom miner:
Expand All @@ -107,13 +122,13 @@ Custom miner:
- replace the `--forward_function base_miner` with `--forward_function your_file`
3. Run the Command:
```
make miner_custom
make miner_custom ENV_FILE=.env.custom
```
### Running a Validator
```
make validator
make validator ENV_FILE=.env.validator
```
Expand Down

0 comments on commit 3853873

Please sign in to comment.