Parameters Objects¶

ParameterGrid¶

class driftai.parameters.parameter_grid.ParameterGrid[source]¶

Responsible of generating the parameter grid.

Parameters:	parameters (list(AbstractParameter)) –

generate_combs()[source]¶

Generate all possible combinations with parameters specified at the constructor

Returns:	Tuple containing the name of parameters and all the possible combinations
Return type:	tuple(list(string), list(any))

get_parameter_count(param)[source]¶

Counts the parameter possible values

Parameters:	param (str) – Name of the parameter
Returns:	Number of possible values of the parameter named <param>
Return type:	int

class driftai.parameters.parameters.CategoricalParameter[source]¶

Represents a categorical parameter

Parameters:	name (str) – Parameter name values (list) – Possible values

generate_vector()[source]¶

Generate all possible values of the parameter

Returns:	All possible values
Return type:	list

class driftai.parameters.parameters.BoolParameter[source]¶

Represents a boolean parameter

class driftai.parameters.parameters.IntParameter[source]¶

Represents an Integer parameter

Parameters:	name (str) – Parameter name initial (int) – Start of interval. The interval includes this value limit (int) – End of interval. The interval does not include this value, except in some cases where step is not an integer and floating point round-off affects the length of out. setp (int) – Spacing between values.

generate_vector()[source]¶: Return evenly spaced values within a given interval

class driftai.parameters.parameters.FloatParameter[source]¶

Represents an Floating parameter

Parameters:	name (str) – Parameter name initial (float) – The starting value of the sequence. limit (float) – The end value of the sequence partitions (int) – Number of samples to generate

generate_vector()[source]¶: Return evenly spaced numbers over a specified interval