Skip to content

Commit 3bb62c4

Browse files
authored
Merge branch 'main' into docs-edits
2 parents c28ed2f + 4014a43 commit 3bb62c4

File tree

2 files changed

+147
-19
lines changed

2 files changed

+147
-19
lines changed

docs/subnets/create-a-subnet.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@ This page describes the procedures for creating a new Bittensor subnet on test c
88

99
You should first try [Creating a Subnet on a locally deployed chain](../local-build/create-subnet).
1010

11-
Creating a subnet is a major undertaking. You should read up on [Understanding Subnets](understanding-subnets) and research existing subnets before planning to create one.
11+
Creating a subnet is a major undertaking. You should read up on [Understanding Subnets](understanding-subnets) and research existing subnets before planning to create one.
1212

1313
## Considerations
14-
1514
### Research existing subnets
1615

1716
Prospective subnet creators should familiarize themselves with the space of existing subnets.
@@ -34,21 +33,19 @@ Check the burn cost to create a subnet on Bittensor main network and test networ
3433
```shell
3534
btcli subnet burn-cost --network finney
3635
```
37-
3836
<codapi-snippet sandbox="python" editor="basic" init-delay="500">
3937
</codapi-snippet>
4038

4139
```shell
4240
btcli subnet burn-cost --network test
4341
```
44-
4542
<codapi-snippet sandbox="python" editor="basic" init-delay="500">
4643
</codapi-snippet>
4744
:::
4845

4946
### A new subnet is not automatically active
5047

51-
To allow subnet owners to fully set up their subnets and to prevent extraction of emissions to subnet participants before the subnet is contributing to the network, new subnets are inactive and cannot be started for 7 \* 7200 blocks (roughly one week) after they are registered. During this time, you can register and activate validators and invite miners into the subnet.
48+
To allow subnet owners to fully set up their subnets and to prevent extraction of emissions to subnet participants before the subnet is contributing to the network, new subnets are inactive and cannot be started for 7 * 7200 blocks (roughly one week) after they are registered. During this time, you can register and activate validators and invite miners into the subnet.
5249

5350
:::info
5451
The subnet and its participants will receive **no emissions** during the time that the subnet is inactive.
@@ -58,7 +55,7 @@ The subnet and its participants will receive **no emissions** during the time th
5855

5956
You must meet the same [requirements for validation](../validators#requirements-for-validation) as other validators in order to set weights in your own subnet.
6057

61-
One option for subnet owners is to ask one of the root network (subnet 0) validators to parent your validator hotkey as a childkey of theirs. This will lend their stake to your validator, and can help you ensure that your validator maintains a sufficient stake to effectively participate in consensus as well as resist deregistration. See the [Child Hotkeys](./child-hotkeys) documentation for more detail.
58+
One option for subnet owners is to ask one of the root network (subnet 0) validators to parent your validator hotkey as a childkey of theirs. This will lend their stake to your validator, and can help you ensure that your validator maintains a sufficient stake to effectively participate in consensus as well as resist deregistration. See the [Child Hotkeys](./child-hotkeys) documentation for more detail.
6259

6360
### Subnet creation rate limits
6461

@@ -67,7 +64,7 @@ Subnet creations are limited to **one subnet creation per 7200 blocks** (approxi
6764
## Prerequisites
6865

6966
- [Install the most recent version of BTCLI](../getting-started/install-btcli).
70-
- [Created a wallet](../getting-started/wallets.md#creating-a-local-wallet).
67+
- [Created a wallet](../getting-started/wallets.md#creating-a-local-wallet).
7168
- To create a subnet on test chain, your wallet must have sufficient test net TAO. Inquire in [Discord](https://discord.com/channels/799672011265015819/1107738550373454028/threads/1331693251589312553) to obtain TAO on Bittensor test network.
7269
- To create a subnet on main network (finney) requires a substantial investment of TAO, depending on current registration cost for new subnets.
7370

@@ -78,11 +75,9 @@ Create your new subnet on the testchain using the test TAO you received from the
7875
Run the create subnet command on the testchain.
7976

8077
```bash
81-
btcli subnet create --network test
78+
btcli subnet create --network test
8279
```
83-
8480
Output:
85-
8681
```bash
8782
# Enter the owner wallet name, which gives the coldkey permissions to define running hyperparameters later.
8883
>> Enter wallet name (default): owner # Enter your owner wallet name
@@ -94,20 +89,18 @@ Output:
9489

9590
## Creating a subnet on mainchain
9691

97-
:::caution Alert: Minimum required TAO
92+
:::caution Alert: Minimum required TAO
9893
Creating a subnet on the mainnet is competitive, and the cost is determined by the rate at which new networks are registered onto the chain.
9994
:::
10095

101-
### Create the subnet
96+
### Create the subnet
10297

103-
Use the below command to create a new subnet on the mainchain.
98+
Use the below command to create a new subnet on the mainchain.
10499

105100
```bash
106101
btcli subnet create
107102
```
108-
109103
Output:
110-
111104
```bash
112105
>> Enter wallet name (default): owner # Enter your owner wallet name
113106
>> Enter password to unlock key: # Enter your wallet password.
@@ -118,20 +111,20 @@ Output:
118111

119112
### Check to see if you can start the subnet
120113

121-
Use the below command to check whether the subnet can be started.
114+
Use the below command to check whether the subnet can be started.
122115

123116
```bash
124117
btcli subnet check-start --netuid x
125118
```
126119

127120
Where "x" is the subnet ID.
128121

129-
The output will provide you with the block registered and the block at which the subnet can be started, with "blocks remaining" and an estimated time. When this time has passed, the `check-start` command will return `Emission schedule can be started.`
122+
The output will provide you with the block registered and the block at which the subnet can be started, with "blocks remaining" and an estimated time. When this time has passed, the `check-start` command will return `Emission schedule can be started.`
130123

131124
### Start the subnet
132125

133-
Use the below command to start the subnet once `check-start` returns `Emission schedule can be started.`
126+
Use the below command to start the subnet once `check-start` returns `Emission schedule can be started.`
134127

135128
```bash
136129
btcli subnet start --netuid x
137-
```
130+
```

static/llms.txt

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
# Bittensor Documentation Resources
2+
3+
## Official Documentation
4+
The primary sources for Bittensor documentation and learning resources.
5+
- Main Documentation: https://docs.bittensor.com - Comprehensive technical documentation covering all aspects of Bittensor
6+
- Learn Bittensor (More Accessible): https://learnbittensor.org - User-friendly explanations and tutorials for beginners
7+
8+
## Core Concepts
9+
### Introduction
10+
- Introduction to Bittensor: https://docs.bittensor.com/learn/introduction
11+
- Learn Bittensor Introduction: https://learnbittensor.org/explore/article/introduction-to-bittensor
12+
13+
### Subnets
14+
- Understanding Subnets: https://docs.bittensor.com/subnets/understanding-subnets
15+
- Creating Subnets: https://docs.bittensor.com/subnets/create-a-subnet
16+
- Subnet Management:
17+
- Subnet Creators Guide: https://docs.bittensor.com/subnets/subnet-creators-btcli-guide
18+
- Subnet Hyperparameters: https://docs.bittensor.com/subnets/subnet-hyperparameters
19+
- Working with Subnets: https://docs.bittensor.com/subnets/working-with-subnets
20+
- Walkthrough of example subnet: https://docs.bittensor.com/subnets/walkthrough-prompting
21+
22+
### Consensus and Emissions
23+
The mechanisms that power Bittensor's incentive system and reward distribution.
24+
- Yuma Consensus: https://docs.bittensor.com/yuma-consensus - Technical details of Bittensor's consensus mechanism
25+
- Emissions: https://docs.bittensor.com/emissions - How TAO and alpha tokens are distributed in the network
26+
27+
## Network Participants
28+
### Miners
29+
Participants who provide AI services to the network.
30+
- Miner Documentation: https://docs.bittensor.com/miners/ - Complete guide to mining on Bittensor
31+
- Miner Guide: https://docs.bittensor.com/miners/miners-btcli-guide - Command-line interface guide for miners
32+
- Learn Bittensor Miner Concept: https://learnbittensor.org/explore/concept/miner - Simplified explanation of mining
33+
34+
### Validators
35+
Network participants who verify and rank miner performance.
36+
- Validator Documentation: https://docs.bittensor.com/validators/ - Comprehensive validator guide
37+
- Validator Guide: https://docs.bittensor.com/validators/validators-btcli-guide - CLI operations for validators
38+
- Child Hotkeys: https://docs.bittensor.com/validators/subnets/child-hotkeys - Managing multiple validator instances
39+
- Learn Bittensor Validator Concept: https://learnbittensor.org/explore/concept/validator - Beginner's guide to validation
40+
41+
### Staking and Delegation
42+
- Staking/Delegation Overview: https://docs.bittensor.com/staking-and-delegation/delegation
43+
- Staking Guides:
44+
- BTCLI Guide: https://docs.bittensor.com/staking-and-delegation/stakers-btcli-guide
45+
- Managing Stake with BTCLI: https://docs.bittensor.com/staking-and-delegation/managing-stake-btcli
46+
- Managing Stake with SDK: https://docs.bittensor.com/staking-and-delegation/managing-stake-sdk
47+
- Polkadot.js Guide: https://docs.bittensor.com/staking-and-delegation/staking-polkadot-js
48+
- Ledger Hardware Wallet: https://docs.bittensor.com/staking-and-delegation/using-ledger-hw-wallet
49+
50+
## Development Tools
51+
Essential tools for building and interacting with Bittensor.
52+
53+
### BTCLI (Command Line Interface)
54+
The primary command-line tool for Bittensor operations.
55+
- Overview: https://docs.bittensor.com/btcli/overview - Introduction to BTCLI
56+
- Installation: https://docs.bittensor.com/getting-started/install-btcli - Setting up BTCLI
57+
- Playground: https://docs.bittensor.com/btcli/btcli-playground - Interactive BTCLI learning environment
58+
- Permissions: https://docs.bittensor.com/btcli-permissions - Understanding BTCLI access levels
59+
60+
### Bittensor Python SDK
61+
- Installation: https://docs.bittensor.com/getting-started/installation
62+
- Wallet SDK Installation: https://docs.bittensor.com/getting-started/install-wallet-sdk
63+
- SDK Documentation:
64+
- Async Subtensor: https://docs.bittensor.com/python-api/autoapi/bittensor/core/async_subtensor/index.html
65+
- Subtensor: https://docs.bittensor.com/python-api/autoapi/bittensor/core/subtensor/index.html
66+
- Migration Guide: https://docs.bittensor.com/migration_guide
67+
- Subtensor Connections: https://docs.bittensor.com/sdk/managing-subtensor-connections
68+
69+
## Security
70+
### Wallets and Keys
71+
- Wallet Basics: https://docs.bittensor.com/getting-started/wallets
72+
- Seed Phrase Security: https://docs.bittensor.com/keys/handle-seed-phrase
73+
- Coldkey/Hotkey Security: https://docs.bittensor.com/getting-started/coldkey-hotkey-security
74+
- Working with Keys: https://docs.bittensor.com/working-with-keys
75+
- Multisig Security: https://docs.bittensor.com/keys/multisig
76+
- Coldkey Rotation: https://docs.bittensor.com/subnets/schedule-coldkey-swap
77+
78+
## Network Environments
79+
### Endpoints
80+
- Mainnet: wss://entrypoint-finney.opentensor.ai:443
81+
- Testnet: wss://test.finney.opentensor.ai:443
82+
- Devnet: wss://dev.chain.opentensor.ai:443
83+
84+
## Advanced Topics
85+
### Local Development
86+
- Local Subtensor Deployment: https://docs.bittensor.com/local-build/deploy
87+
88+
### Subtensor Nodes
89+
- Node Basics: https://docs.bittensor.com/subtensor-nodes/
90+
- Node Requirements: https://docs.bittensor.com/subtensor-nodes/subtensor-node-requirements
91+
- Source Installation: https://docs.bittensor.com/subtensor-nodes/using-source
92+
- Docker Installation: https://docs.bittensor.com/subtensor-nodes/using-docker
93+
- Rate Limits: https://docs.bittensor.com/subtensor-nodes/subtensor-rate-limits
94+
- Storage Queries: https://docs.bittensor.com/subtensor-nodes/subtensor-storage-query-examples
95+
- Error Messages: https://docs.bittensor.com/subtensor-nodes/subtensor-error-messages
96+
97+
### EVM Integration
98+
- EVM on Bittensor Overview: https://docs.bittensor.com/evm-tutorials/
99+
- EVM on Subtensor: https://docs.bittensor.com/evm-tutorials/evm-on-subtensor
100+
- Installation: https://docs.bittensor.com/evm-tutorials/install
101+
- Setup:
102+
- Hardhat Config: https://docs.bittensor.com/evm-tutorials/hardhat-config-for-subtensor-evm
103+
- Testnet: https://docs.bittensor.com/evm-tutorials/evm-testnet-with-metamask-wallet
104+
- Localnet: https://docs.bittensor.com/evm-tutorials/evm-localnet-with-metamask-wallet
105+
- Mainnet: https://docs.bittensor.com/evm-tutorials/evm-mainnet-with-metamask-wallet
106+
- Precompiles:
107+
- Metamask to SS58: https://docs.bittensor.com/evm-tutorials/transfer-from-metamask-to-ss58
108+
- Between H160 Accounts: https://docs.bittensor.com/evm-tutorials/transfer-between-two-h160-accounts
109+
- Staking Precompile: https://docs.bittensor.com/evm-tutorials/staking-precompile
110+
- ED25519 Verify: https://docs.bittensor.com/evm-tutorials/ed25519-verify-precompile
111+
112+
### Governance
113+
- Overview: https://docs.bittensor.com/governance
114+
- Senate: https://docs.bittensor.com/senate
115+
- Senator Guide: https://docs.bittensor.com/governance/senators-btcli-guide
116+
117+
### Dynamic TAO
118+
- Guide: https://docs.bittensor.com/dynamic-tao/dtao-guide
119+
- SDK Cheat Sheet: https://docs.bittensor.com/dynamic-tao/sdk-cheat-sheet
120+
121+
## Releases
122+
### Bittensor
123+
- PyPI: https://pypi.org/project/bittensor/
124+
- GitHub: https://github.com/opentensor/bittensor/releases
125+
126+
### BTCLI
127+
- PyPI: https://pypi.org/project/bittensor-cli/
128+
- GitHub: https://github.com/opentensor/btcli/releases
129+
130+
### Subtensor
131+
- GitHub: https://github.com/opentensor/subtensor/releases
132+
133+
## Additional Resources
134+
- Glossary: https://docs.bittensor.com/glossary
135+

0 commit comments

Comments
 (0)