Skip to content

OptimizationStepParameter

QuantConnect.Optimizer.Parameters.OptimizationStepParameter

OptimizationStepParameter(
    name: str, min: float, max: float
)
OptimizationStepParameter(
    name: str, min: float, max: float, step: float
)
OptimizationStepParameter(
    name: str,
    min: float,
    max: float,
    step: float,
    min_step: float,
)

Bases: OptimizationParameter

Defines the step based optimization parameter

Create an instance of OptimizationParameter based on configuration

Parameters:

Name Type Description Default
name str

parameter name

required
min float

minimal value

required
max float

maximal value

required
step Optional[float]

movement

None
min_step Optional[float]

minimal possible movement

None

min_value

min_value: float

Minimum value of optimization parameter, applicable for boundary conditions

max_value

max_value: float

Maximum value of optimization parameter, applicable for boundary conditions

step

step: Optional[float]

Movement, should be positive

min_step

min_step: Optional[float]

name

name: str

Name of optimization parameter

equals

equals(obj: Any) -> bool
equals(other: OptimizationParameter) -> bool

Signature descriptions:

  • Determines whether the specified object is equal to the current object.

  • Indicates whether the current object is equal to another object of the same type.

Parameters:

Name Type Description Default
obj Optional[Any]

The object to compare with the current object.

None
other Optional[OptimizationParameter]

An object to compare with this object.

None

Returns:

Type Description
bool

Depends on the signature used. Case 1: [true if the specified object is equal to the current object; otherwise, false.]; Case 2: [true if the current object is equal to the other parameter; otherwise, false.]

get_hash_code

get_hash_code() -> int

Serves as the default hash function.

Returns:

Type Description
int

A hash code for the current object.