Skip to main content

addons.tune.ax

Handles the ax backend

AxTunerStatus Objects#

class AxTunerStatus(TypedDict)

Tuner status return object for Ax -- supports the service style API from Ax

Attributes:

  • client - current AxClient instance
  • trial_index - current trial index

AxInterface Objects#

class AxInterface(BaseInterface)

Specific override to support the Ax backend -- supports the service style API from Ax

__init__#

def __init__(tuner_config: AxTunerConfig, tuner_namespace)

AxInterface init call that maps variables, creates a map to fnc calls, and constructs the necessary underlying objects

Arguments:

  • tuner_config - configuration object for the ax backend
  • tuner_namespace - tuner namespace that has attr classes that maps to an underlying library types

_ax_range#

def _ax_range(name, val)

Assemble the dictionary for ax range parameters

Arguments:

  • name - parameter name
  • val - current attr val

Returns:

dictionary that can be added to a parameter list

_ax_choice#

def _ax_choice(name, val)

Assemble the dictionary for ax choice parameters

Arguments:

  • name - parameter name
  • val - current attr val

Returns:

dictionary that can be added to a parameter list