setup

openml.setups.setup

OpenMLParameter

OpenMLParameter(input_id: int, flow_id: int, flow_name: str, full_name: str, parameter_name: str, data_type: str, default_value: str, value: str)

Parameter object (used in setup).

PARAMETER	DESCRIPTION
input_id	The input id from the openml database TYPE: int
flow	The flow to which this parameter is associated
flow	The name of the flow (no version number) to which this parameter is associated
full_name	The name of the flow and parameter combined TYPE: str
parameter_name	The name of the parameter TYPE: str
data_type	The datatype of the parameter. generally unused for sklearn flows TYPE: str
default_value	The default value. For sklearn parameters, this is unknown and a default value is selected arbitrarily TYPE: str
value	If the parameter was set, the value that it was set to. TYPE: str

Source code in openml/setups/setup.py

def __init__(  # noqa: PLR0913
    self,
    input_id: int,
    flow_id: int,
    flow_name: str,
    full_name: str,
    parameter_name: str,
    data_type: str,
    default_value: str,
    value: str,
):
    self.id = input_id
    self.flow_id = flow_id
    self.flow_name = flow_name
    self.full_name = full_name
    self.parameter_name = parameter_name
    self.data_type = data_type
    self.default_value = default_value
    self.value = value

OpenMLSetup

OpenMLSetup(setup_id: int, flow_id: int, parameters: dict[int, Any] | None)

Setup object (a.k.a. Configuration).

PARAMETER	DESCRIPTION
setup_id	The OpenML setup id TYPE: int
flow_id	The flow that it is build upon TYPE: int
parameters	The setting of the parameters TYPE: dict

Source code in openml/setups/setup.py

def __init__(self, setup_id: int, flow_id: int, parameters: dict[int, Any] | None):
    if not isinstance(setup_id, int):
        raise ValueError("setup id should be int")

    if not isinstance(flow_id, int):
        raise ValueError("flow id should be int")

    if parameters is not None and not isinstance(parameters, dict):
        raise ValueError("parameters should be dict")

    self.setup_id = setup_id
    self.flow_id = flow_id
    self.parameters = parameters