Tuners

GolemTuner

class gefest.tools.tuners.tuner.TunerType(value)[source]

Bases: Enum

Enumeration of all GOLEM tuner classes.

iopt(*args, **kwargs) = <class 'golem.core.tuning.iopt_tuner.IOptTuner'>
optuna(*args, **kwargs) = <class 'golem.core.tuning.optuna_tuner.OptunaTuner'>
sequential(*args, **kwargs) = <class 'golem.core.tuning.sequential.SequentialTuner'>
simulataneous(*args, **kwargs) = <class 'golem.core.tuning.simultaneous.SimultaneousTuner'>
class gefest.tools.tuners.tuner.GolemTuner(opt_params: OptimizationParams, **kwargs)[source]

Bases: object

Wrap for GOLEM tuners.

Provides interface for tuning stucture points coordinates. For more details about tuners see:

tune(objects_for_tune: Structure | list[Structure]) list[Structure][source]

Tunes coordinstes for all points in each provided structure.

Parameters:

objects_for_tune (Union[Structure, list[Structure]]) – Structures for tune.

Returns:

Tuned structures.

Return type:

list[Structure]

Utils

gefest.tools.tuners.utils.percent_edge_variance(structure: Structure, domain: Domain, percent: float = 0.5) list[float][source]

Generates tuning variance for each point.

Variance is equal to half the average edge length of the polygon.

Returns:

list of variances for each point in structure

Return type:

list[float]