search

opentensor / developer-docs

Developer documentation for Bittensor.
https://docs.bittensor.com
18 stars 22 forks source link

Document btcli profile command #198

Open rajkaramchedu opened 4 months ago

rajkaramchedu commented 4 months ago

See this PR and document what's necessary. https://github.com/opentensor/bittensor/pull/1784

rajkaramchedu commented 4 months ago

cc: @gus-opentensor

rajkaramchedu commented 3 months ago

Posting these questions here for future reference when documenting this feature.

  1. The main purpose of btcli profile create is so that the user can simply pass the config file to a command like python neurons/validator.py --netuid 1 --subtensor.network test --wallet.name validator --wallet.hotkey default --logging.debug instead of typing all these options and their values, correct?

  2. How would I pass the created config file? Like, python neurons/validator.py --config ~/.bittensor/profiles/myfirstprofile?

  3. Are these below the only key-value pairs created in the profile file? -- name (is this the name of the output file name, like "myfirstprofile" above? -- path (path to the location of the "myfirstprofile" I think?) -- coldkey: does it accept both "0x" prefixed-format and also the SS58 format? -- hotkey: same q as above -- subtensor_network: allowed values I think are "test, finney, local" correct? -- active_netuid: I think the netuid of interest

  4. In the screenshot in the PR, I see that provided inputs are "1" and "2" and "3" for the prompted fields. Does it mean it is not doing any typecheck?

  5. Two terms are used in the PR: "profile" and "config" so a single profile can contain multiple configs, correct?

  6. Lastly, are these config files in plain text format or yaml or ? Asking because can the user simply follow a sample file example and manually create these profiles and configs for each profile? A good option to document if this is true.