hgq.constraints package

Module contents

class hgq.constraints.Max(max_value: int | float | integer | floating)

Bases: Constraint

Constrains the weights to less or equal than max_value.

get_config()

Returns a Python dict of the object config.

A constraint config is a Python dictionary (JSON-serializable) that can be used to reinstantiate the same object.

Returns:

Python dict containing the configuration of the constraint object.

class hgq.constraints.Min(min_value: int | float | integer | floating)

Bases: Constraint

Constrains the weights to greater or equal than min_value.

get_config()

Returns a Python dict of the object config.

A constraint config is a Python dictionary (JSON-serializable) that can be used to reinstantiate the same object.

Returns:

Python dict containing the configuration of the constraint object.

class hgq.constraints.MinMax(min_value: int | float | integer | floating, max_value: int | float | integer | floating)

Bases: Constraint

Constrains the weights to between min_value and max_value.

get_config()

Returns a Python dict of the object config.

A constraint config is a Python dictionary (JSON-serializable) that can be used to reinstantiate the same object.

Returns:

Python dict containing the configuration of the constraint object.