Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated docs #227

Open
wants to merge 1 commit into
base: production
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions core/create_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,11 @@ def generate_miner_config(dev: bool = False) -> dict[str, Any]:
config["WALLET_NAME"] = input("Enter wallet name (default: default): ") or "default"
config["HOTKEY_NAME"] = input("Enter hotkey name (default: default): ") or "default"
config["SUBTENSOR_NETWORK"] = input("Enter subtensor network (default: test): ") or "test"
subtensor_address = validate_input("Enter subtensor address (default: None): ", websocket_validator)
if subtensor_address:
config["SUBTENSOR_ADDRESS"] = subtensor_address
if config["SUBTENSOR_NETWORK"] == 'test':
subtensor_address = 'wss://test.finney.opentensor.ai:443'
else:
subtensor_address = 'wss://entrypoint-finney.opentensor.ai:443'
config["SUBTENSOR_ADDRESS"] = subtensor_address

default_stake_threshold = "0" if config["SUBTENSOR_NETWORK"] == "test" else "1000"
config["NETUID"] = 176 if config["SUBTENSOR_NETWORK"] == "test" else 19
Expand Down
10 changes: 8 additions & 2 deletions docs/mining.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,21 @@ python core/create_config.py --miner
## Post IP's to chain
Example command:
```bash
fiber-post-ip --netuid 176 --subtensor.network test --external_port 1234 --wallet.name default --wallet.hotkey default --external_ip 0.0.0.0
fiber-post-ip --netuid 176 --subtensor.network test --external_port 4001 --wallet.name default --wallet.hotkey default --external_ip 0.0.0.0
```

## Start miners

(If you are a dev, go to dev.md docs now)
Example command
```bash
uvicorn miner.server:app --reload --host 0.0.0.0 --port 1234 --env-file .default.env --log-level debug &
uvicorn miner.server:app --reload --host 0.0.0.0 --port 4001 --env-file .default.env --log-level debug &
```

Use the process manager of your choice

## Tips
- Miners may want to modify the code for `/capacity` endpoint in `miner/endpoints/generic.py` to declare maximum capacity to each validator if possible to stay competent.
- The core scoring mechanism followed by validator(s) is given in `validator/control_node/src/cycle/calculations.py`.
- Check out the latest metrics of competing miners on https://nineteen.ai/app/research/leaderboards (valid at the time of writing, pop a query in 19 channel in Bittensor discord server if invalid)
- To manually analyse reward data assigned to individual requests served to validators, use https://taovision.ai/v1/read/reward_data endpoint and input validator hotkey (https://nineteen.ai/app/research/validators) & your miner hotkey.