Skip to content

Commit 616efd1

Browse files
authored
Merge pull request #598 from opentensor/chore/thewhaleking/expand-readme
expand readme
2 parents c11773e + d79248c commit 616efd1

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,13 @@ You can set the commonly used values, such as your hotkey and coldkey names, the
135135
The default location of the config file is: `~/.bittensor/config.yml`. An example of a `config.yml` is shown below:
136136

137137
```yaml
138-
chain: ws://127.0.0.1:9945
139138
network: local
140-
no_cache: False
141-
wallet_hotkey: hotkey-user1
139+
use_cache: true
140+
dashboard_path: null
141+
disk_cache: false
142+
rate_tolerance: null
143+
safe_staking: true
144+
wallet_hotkey: default
142145
wallet_name: coldkey-user1
143146
wallet_path: ~/.bittensor/wallets
144147
metagraph_cols:
@@ -165,6 +168,13 @@ metagraph_cols:
165168
btcli config --help
166169
```
167170

171+
### ENV VARS
172+
BTCLI accepts a few environment variables that can alter how it works:
173+
- USE_TORCH (default 0): If set to 1, will use torch instead of numpy
174+
- DISK_CACHE (default 0, also settable in config): If set to 1 (or set in config), will use disk caching for various safe-cachable substrate
175+
calls (such as block number to block hash mapping), which can speed up subsequent calls.
176+
- BTCLI_CONFIG_PATH (default `~/.bittensor/config.yml`): This will set the config file location, creating if it does not exist.
177+
168178
---
169179

170180
## License

0 commit comments

Comments
 (0)