prompting.baseminer.config#

Module Contents#

Functions#

check_config(cls, config)

Validates the given configuration for the Miner by ensuring all necessary settings

get_config()

Initializes and retrieves a configuration object for the Miner. This function sets up
prompting.baseminer.config.check_config(cls, config)#

Validates the given configuration for the Miner by ensuring all necessary settings and directories are correctly set up. It checks the config for axon, wallet, logging, and subtensor. Additionally, it ensures that the logging directory exists or creates one.

Parameters:

  • cls – The class reference, typically referring to the Miner class.

  • config (bt.Config) – The configuration object holding various settings for the miner.

Raises:

  • Various exceptions can be raised by the check_config methods of axon, wallet, logging, –

  • and subtensor if the configurations are not valid. –

prompting.baseminer.config.get_config()#

Initializes and retrieves a configuration object for the Miner. This function sets up and reads the command-line arguments to customize various miner settings. The function also sets up the logging directory for the miner.

Returns:

A configuration object populated with settings from command-line arguments

and defaults where necessary.

Return type:

bt.Config

Note

Running this function with the –help argument will print a help message detailing all the available command-line arguments for customization.