opentensor · ifrit98 · Jan 25, 2024 · Jan 22, 2024 · Jan 22, 2024 · Jan 22, 2024
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,28 @@
 # Changelog
 
+
+## 6.7.0 / 2024-01-25
+
+## What's Changed
+* First docstrings formatting PR by @rajkaramchedu in https://github.com/opentensor/bittensor/pull/1663
+* Second docstrings formatting PR by @rajkaramchedu in https://github.com/opentensor/bittensor/pull/1665
+* Third docstrings formatting PR by @rajkaramchedu in https://github.com/opentensor/bittensor/pull/1666
+* updated mac yaml mac yaml by @dougsillars in https://github.com/opentensor/bittensor/pull/1668
+* Fourth docstrings formatting PR by @rajkaramchedu in https://github.com/opentensor/bittensor/pull/1670
+* Fifth docstrings formatting PR by @rajkaramchedu in https://github.com/opentensor/bittensor/pull/1671
+* ensure branch off from staging and rm old docs by @ifrit98 in https://github.com/opentensor/bittensor/pull/1667
+* staging black format fix by @ifrit98 in https://github.com/opentensor/bittensor/pull/1669
+* wallet history url for taostats by @ifrit98 in https://github.com/opentensor/bittensor/pull/1672
+* take bt.config as a first argument regardless if specified by @ifrit98 in https://github.com/opentensor/bittensor/pull/1664
+* Hparams update by @ifrit98 in https://github.com/opentensor/bittensor/pull/1673
+
+## New Contributors
+* @rajkaramchedu made their first contribution in https://github.com/opentensor/bittensor/pull/1663
+* @dougsillars made their first contribution in https://github.com/opentensor/bittensor/pull/1668
+
+**Full Changelog**: https://github.com/opentensor/bittensor/compare/v6.6.1...v6.7.0
+
+
 ## 6.6.1 / 2024-01-17
 
 ## What's Changed

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-6.6.1
+6.7.0
diff --git a/bittensor/__init__.py b/bittensor/__init__.py
@@ -27,7 +27,7 @@
 nest_asyncio.apply()
 
 # Bittensor code and protocol version.
-__version__ = "6.6.1"
+__version__ = "6.7.0"
 
 version_split = __version__.split(".")
 __version_as_int__ = (

diff --git a/bittensor/axon.py b/bittensor/axon.py
diff --git a/bittensor/commands/delegates.py b/bittensor/commands/delegates.py
diff --git a/bittensor/commands/identity.py b/bittensor/commands/identity.py
@@ -9,21 +9,22 @@
 
 class SetIdentityCommand:
     """
-    Executes the 'set_identity' command within the Bittensor network, which allows for the
-    creation or update of a delegate's on-chain identity. This identity includes various
+    Executes the :func:`set_identity` command within the Bittensor network, which allows for the creation or update of a delegate's on-chain identity.
+
+    This identity includes various
     attributes such as display name, legal name, web URL, PGP fingerprint, and contact
     information, among others.
 
     Optional Arguments:
-    --display: The display name for the identity.
-    --legal: The legal name for the identity.
-    --web: The web URL for the identity.
-    --riot: The riot handle for the identity.
-    --email: The email address for the identity.
-    --pgp_fingerprint: The PGP fingerprint for the identity.
-    --image: The image URL for the identity.
-    --info: The info for the identity.
-    --twitter: The twitter URL for the identity.
+        - ``display``: The display name for the identity.
+        - ``legal``: The legal name for the identity.
+        - ``web``: The web URL for the identity.
+        - ``riot``: The riot handle for the identity.
+        - ``email``: The email address for the identity.
+        - ``pgp_fingerprint``: The PGP fingerprint for the identity.
+        - ``image``: The image URL for the identity.
+        - ``info``: The info for the identity.
+        - ``twitter``: The X (twitter) URL for the identity.
 
     The command prompts the user for the different identity attributes and validates the
     input size for each attribute. It provides an option to update an existing validator
@@ -33,25 +34,26 @@ class SetIdentityCommand:
     Each field has a maximum size of 64 bytes. The PGP fingerprint field is an exception
     and has a maximum size of 20 bytes. The user is prompted to enter the PGP fingerprint
     as a hex string, which is then converted to bytes. The user is also prompted to enter
-    the coldkey or hotkey ss58 address for the identity to be updated. If the user does
+    the coldkey or hotkey ``ss58`` address for the identity to be updated. If the user does
     not have a hotkey, the coldkey address is used by default.
 
     If setting a validator identity, the hotkey will be used by default. If the user is
     setting an identity for a subnet, the coldkey will be used by default.
 
     Usage:
-    The user should call this command from the command line and follow the interactive
-    prompts to enter or update the identity information. The command will display the
-    updated identity details in a table format upon successful execution.
+        The user should call this command from the command line and follow the interactive
+        prompts to enter or update the identity information. The command will display the
+        updated identity details in a table format upon successful execution.
+
+    Example usage::
 
-    Example usage:
-    >>> btcli root set_identity
+        btcli wallet set_identity
 
     Note:
-    This command should only be used if the user is willing to incur the 1 TAO transaction
-    fee associated with setting an identity on the blockchain. It is a high-level command
-    that makes changes to the blockchain state and should not be used programmatically as
-    part of other scripts or applications.
+        This command should only be used if the user is willing to incur the 1 TAO transaction
+        fee associated with setting an identity on the blockchain. It is a high-level command
+        that makes changes to the blockchain state and should not be used programmatically as
+        part of other scripts or applications.
     """
 
     def run(cli: "bittensor.cli"):
@@ -240,33 +242,35 @@ def add_args(parser: argparse.ArgumentParser):
 
 class GetIdentityCommand:
     """
-    Executes the 'get_identity' command, which retrieves and displays the identity details
-    of a user's coldkey or hotkey associated with the Bittensor network. This function
+    Executes the :func:`get_identity` command, which retrieves and displays the identity details of a user's coldkey or hotkey associated with the Bittensor network. This function
     queries the subtensor chain for information such as the stake, rank, and trust associated
     with the provided key.
 
     Optional Arguments:
-    --key: The ss58 address of the coldkey or hotkey to query.
+        - ``key``: The ``ss58`` address of the coldkey or hotkey to query.
 
     The command performs the following actions:
+
     - Connects to the subtensor network and retrieves the identity information.
     - Displays the information in a structured table format.
 
     The displayed table includes:
-    - Address: The ss58 address of the queried key.
-    - Item: Various attributes of the identity such as stake, rank, and trust.
-    - Value: The corresponding values of the attributes.
+
+    - **Address**: The ``ss58`` address of the queried key.
+    - **Item**: Various attributes of the identity such as stake, rank, and trust.
+    - **Value**: The corresponding values of the attributes.
 
     Usage:
-    The user must provide an ss58 address as input to the command. If the address is not
-    provided in the configuration, the user is prompted to enter one.
+        The user must provide an ``ss58`` address as input to the command. If the address is not
+        provided in the configuration, the user is prompted to enter one.
+
+    Example usage::
 
-    Example usage:
-    >>> btli get_identity --key <s58_address>
+        btcli wallet get_identity --key <s58_address>
 
     Note:
-    This function is designed for CLI use and should be executed in a terminal. It is
-    primarily used for informational purposes and has no side effects on the network state.
+        This function is designed for CLI use and should be executed in a terminal. It is
+        primarily used for informational purposes and has no side effects on the network state.
     """
 
     def run(cli: "bittensor.cli"):

diff --git a/bittensor/commands/inspect.py b/bittensor/commands/inspect.py
@@ -73,41 +73,44 @@ def _get_hotkey_wallets_for_wallet(wallet) -> List["bittensor.wallet"]:
 
 class InspectCommand:
     """
-    Executes the 'inspect' command, which compiles and displays a detailed report of a user's
-    wallet pairs (coldkey, hotkey) on the Bittensor network. This report includes balance and
+    Executes the ``inspect`` command, which compiles and displays a detailed report of a user's wallet pairs (coldkey, hotkey) on the Bittensor network.
+
+    This report includes balance and
     staking information for both the coldkey and hotkey associated with the wallet.
 
     Optional arguments:
-    -all: If set to True, the command will inspect all wallets located within the specified
-    path. If set to False, the command will inspect only the wallet specified by the user.
+        - ``all``: If set to ``True``, the command will inspect all wallets located within the specified path. If set to ``False``, the command will inspect only the wallet specified by the user.
 
     The command gathers data on:
+
     - Coldkey balance and delegated stakes.
     - Hotkey stake and emissions per neuron on the network.
     - Delegate names and details fetched from the network.
 
     The resulting table includes columns for:
-    - Coldkey: The coldkey associated with the user's wallet.
-    - Balance: The balance of the coldkey.
-    - Delegate: The name of the delegate to which the coldkey has staked funds.
-    - Stake: The amount of stake held by both the coldkey and hotkey.
-    - Emission: The emission or rewards earned from staking.
-    - Netuid: The network unique identifier of the subnet where the hotkey is active.
-    - Hotkey: The hotkey associated with the neuron on the network.
+
+    - **Coldkey**: The coldkey associated with the user's wallet.
+    - **Balance**: The balance of the coldkey.
+    - **Delegate**: The name of the delegate to which the coldkey has staked funds.
+    - **Stake**: The amount of stake held by both the coldkey and hotkey.
+    - **Emission**: The emission or rewards earned from staking.
+    - **Netuid**: The network unique identifier of the subnet where the hotkey is active.
+    - **Hotkey**: The hotkey associated with the neuron on the network.
 
     Usage:
-    This command can be used to inspect a single wallet or all wallets located within a
-    specified path. It is useful for a comprehensive overview of a user's participation
-    and performance in the Bittensor network.
+        This command can be used to inspect a single wallet or all wallets located within a
+        specified path. It is useful for a comprehensive overview of a user's participation
+        and performance in the Bittensor network.
+
+    Example usage::
 
-    Example usage:
-    >>> btcli inspect
-    >>> btcli inspect --all
+            btcli wallet inspect
+            btcli wallet inspect --all
 
     Note:
-    The 'inspect' command is for displaying information only and does not perform any
-    transactions or state changes on the Bittensor network. It is intended to be used as
-    part of the Bittensor CLI and not as a standalone function within user code.
+        The ``inspect`` command is for displaying information only and does not perform any
+        transactions or state changes on the Bittensor network. It is intended to be used as
+        part of the Bittensor CLI and not as a standalone function within user code.
     """
 
     @staticmethod

diff --git a/bittensor/commands/list.py b/bittensor/commands/list.py
@@ -26,28 +26,26 @@
 
 class ListCommand:
     """
-    Executes the 'list' command which enumerates all wallets and their respective hotkeys
-    present in the user's Bittensor configuration directory. The command organizes the
-    information in a tree structure, displaying each wallet along with the SS58 addresses
-    for the coldkey public key and any hotkeys associated with it.
+    Executes the ``list`` command which enumerates all wallets and their respective hotkeys present in the user's Bittensor configuration directory.
+
+    The command organizes the information in a tree structure, displaying each wallet along with the ``ss58`` addresses for the coldkey public key and any hotkeys associated with it.
 
     Optional arguments:
-    -p, --path: The path to the Bittensor configuration directory. Defaults to '~/.bittensor'.
+        - ``-p``, ``--path``: The path to the Bittensor configuration directory. Defaults to '~/.bittensor'.
 
     The output is presented in a hierarchical tree format, with each wallet as a root node,
-    and any associated hotkeys as child nodes. The SS58 address is displayed for each
+    and any associated hotkeys as child nodes. The ``ss58`` address is displayed for each
     coldkey and hotkey that is not encrypted and exists on the device.
 
     Usage:
-    Upon invocation, the command scans the wallet directory and prints a list of all wallets,
-    indicating whether the public keys are available ('?' denotes unavailable or encrypted keys).
+        Upon invocation, the command scans the wallet directory and prints a list of all wallets, indicating whether the public keys are available (``?`` denotes unavailable or encrypted keys).
+
+    Example usage::
 
-    Example usage:
-    >>> btcli list --path ~/.bittensor
+        btcli wallet list --path ~/.bittensor
 
     Note:
-    This command is read-only and does not modify the filesystem or the network state. It is
-    intended for use within the Bittensor CLI to provide a quick overview of the user's wallets.
+        This command is read-only and does not modify the filesystem or the network state. It is intended for use within the Bittensor CLI to provide a quick overview of the user's wallets.
     """
 
     @staticmethod

diff --git a/bittensor/commands/metagraph.py b/bittensor/commands/metagraph.py
@@ -26,16 +26,18 @@
 
 class MetagraphCommand:
     """
-    Executes the 'metagraph' command to retrieve and display the entire metagraph
-    for a specified network. This metagraph contains detailed information about
+    Executes the ``metagraph`` command to retrieve and display the entire metagraph for a specified network.
+
+    This metagraph contains detailed information about
     all the neurons (nodes) participating in the network, including their stakes,
     trust scores, and more.
 
     Optional arguments:
-    --netuid: The netuid of the network to query. Defaults to the default network UID.
-    --subtensor.network: The name of the network to query. Defaults to the default network name.
+        - ``--netuid``: The netuid of the network to query. Defaults to the default network UID.
+        - ``--subtensor.network``: The name of the network to query. Defaults to the default network name.
 
     The table displayed includes the following columns for each neuron:
+
     - UID: Unique identifier of the neuron.
     - STAKE(τ): Total stake of the neuron in Tau (τ).
     - RANK: Rank score of the neuron.
@@ -52,21 +54,20 @@ class MetagraphCommand:
     - HOTKEY: Partial hotkey (public key) of the neuron.
     - COLDKEY: Partial coldkey (public key) of the neuron.
 
-    The command also prints network-wide statistics such as total stake, issuance,
-    and difficulty.
+    The command also prints network-wide statistics such as total stake, issuance, and difficulty.
 
     Usage:
-    The user must specify the network UID to query the metagraph. If not specified,
-    the default network UID is used.
+        The user must specify the network UID to query the metagraph. If not specified, the default network UID is used.
+
+    Example usage::
 
-    Example usage:
-    >>> btcli metagraph --netuid 0 # Root network
-    >>> btcli metagraph --netuid 1 --subtensor.network test
+        btcli subnet metagraph --netuid 0 # Root network
+        btcli subnet metagraph --netuid 1 --subtensor.network test
 
     Note:
-    This command provides a snapshot of the network's state at the time of calling.
-    It is useful for network analysis and diagnostics. It is intended to be used as
-    part of the Bittensor CLI and not as a standalone function within user code.
+        This command provides a snapshot of the network's state at the time of calling.
+        It is useful for network analysis and diagnostics. It is intended to be used as
+        part of the Bittensor CLI and not as a standalone function within user code.
     """
 
     @staticmethod

diff --git a/bittensor/commands/misc.py b/bittensor/commands/misc.py
@@ -28,22 +28,26 @@
 
 class UpdateCommand:
     """
-    Executes the 'update' command to update the local Bittensor package. This command performs a series of operations to ensure that the user's local Bittensor installation is updated to the latest version from the master branch of its GitHub repository. It primarily involves pulling the latest changes from the repository and reinstalling the package.
+    Executes the ``update`` command to update the local Bittensor package.
+
+    This command performs a series of operations to ensure that the user's local Bittensor installation is updated to the latest version from the master branch of its GitHub repository. It primarily involves pulling the latest changes from the repository and reinstalling the package.
 
     Usage:
-    Upon invocation, the command first checks the user's configuration for the 'no_prompt' setting. If 'no_prompt' is set to True, or if the user explicitly confirms with 'Y' when prompted, the command proceeds to update the local Bittensor package. It changes the current directory to the Bittensor package directory, checks out the master branch of the Bittensor repository, pulls the latest changes, and then reinstalls the package using pip.
+        Upon invocation, the command first checks the user's configuration for the ``no_prompt`` setting. If ``no_prompt`` is set to ``True``, or if the user explicitly confirms with ``Y`` when prompted, the command proceeds to update the local Bittensor package. It changes the current directory to the Bittensor package directory, checks out the master branch of the Bittensor repository, pulls the latest changes, and then reinstalls the package using ``pip``.
 
     The command structure is as follows:
+
     1. Change directory to the Bittensor package directory.
     2. Check out the master branch of the Bittensor GitHub repository.
-    3. Pull the latest changes with the '--ff-only' option to ensure a fast-forward update.
+    3. Pull the latest changes with the ``--ff-only`` option to ensure a fast-forward update.
     4. Reinstall the Bittensor package using pip.
 
-    Example usage:
-    >>> btcli legacy update
+    Example usage::
+
+        btcli legacy update
 
     Note:
-    This command is intended to be used within the Bittensor CLI to facilitate easy updates of the Bittensor package. It should be used with caution as it directly affects the local installation of the package. It is recommended to ensure that any important data or configurations are backed up before running this command.
+        This command is intended to be used within the Bittensor CLI to facilitate easy updates of the Bittensor package. It should be used with caution as it directly affects the local installation of the package. It is recommended to ensure that any important data or configurations are backed up before running this command.
     """
 
     @staticmethod