Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation Update: Commitment Data Example
1. The Problem
The
get_commitmentmethod inbittensor/core/subtensor.pycontained a placeholder comment in its docstring:# TODO: add a real example of how to handle realistic commitment data, or chop exampleThis was insufficient for developers trying to understand how to effectively use the commitment mechanism, particularly regarding data formatting.
2. Thought Process
Commitment data on the Bittensor blockchain is stored as a raw string (or bytes). However, "realistic" usage almost always involves structured data, such as:
To make the example useful, it needed to demonstrate:
set_commitment.get_commitmentand parse it.3. The Solution
I updated the docstring of
subtensor.get_commitmentto include a complete, runnable example.The Added Code
This ensures developers have a clear pattern to follow for handling metadata on the chain.
Contribution by Gittensor, learn more at https://gittensor.io/