Skip to content

Index

sgp.models.optimize.Optimizers module-attribute 

Optimizers = Literal['Scipy-LBFGSB', 'Scipy-NelderMead', 'Scipy-Powell', 'Scipy-TNC', 'SKO-DE', 'SKO-GA', 'SKO-PSO', 'SKO-SA', 'SKO-AFSA']

sgp.models.optimize.__all__ module-attribute 

__all__ = ['LBFGSB', 'NelderMead', 'Powell', 'TNC', 'ScipyResult', 'Optimizers', 'SKOAFSA', 'SKODE', 'SKOGA', 'SKOPSO', 'SKOSA', 'SKOAFSAResult', 'SKODEResult', 'SKOGAResult', 'SKOPSOResult', 'SKOSAResult', 'register', 'registry']

sgp.models.optimize.registry module-attribute 

registry: Registry[str, Type[OptimizerBase]] = Registry()

sgp.models.optimize.LBFGSB

Bases: ScipyOptimizer

sgp.models.optimize.NelderMead

Bases: ScipyOptimizer

sgp.models.optimize.Powell

Bases: ScipyOptimizer

sgp.models.optimize.SKOAFSA

Bases: SKOOptimizer

sgp.models.optimize.SKOAFSAResult

Bases: SKOOptimizerResult

sgp.models.optimize.SKODE

Bases: SKOOptimizer

sgp.models.optimize.SKODEResult

Bases: SKOGeneticAlgorithmResult

sgp.models.optimize.SKOGA

Bases: SKOOptimizer

sgp.models.optimize.SKOGAResult

Bases: SKOGeneticAlgorithmResult

sgp.models.optimize.SKOPSO

Bases: SKOOptimizer

sgp.models.optimize.SKOPSOResult

Bases: SKOOptimizerResult

sgp.models.optimize.SKOSA

Bases: SKOOptimizer

sgp.models.optimize.SKOSAResult

Bases: SKOOptimizerResult

sgp.models.optimize.ScipyResult

Bases: OptimizerResult

Represents the optimization result for scipy optimize algorithms

Notes

OptimizeResult may have additional attributes not listed here depending on the specific solver being used. Since this class is essentially a subclass of dict with attribute accessors, one can see which attributes are available using the OptimizeResult.keys method.

sgp.models.optimize.TNC

Bases: ScipyOptimizer

sgp.models.optimize.register 

register(cls_or_name: Type[OptimizerBase] | str | None = None, name: str | None = None, *, jitclass: bool = False, spec: List[Tuple[str, type]] | Mapping[str, Type] | None = None, saveto: Registry | None = None, **methods) -> Type | Callable

Register a new model

Examples:

The following calls are equivalent:

1) cls_or_name = "Foo", name = None

@register("Foo") ... class Foo: ... ...

2) cls_or_name = None, name = "Foo"

@register(name="Foo") ... class Foo: ... ...

3) cls_or_name = Foo, name = "Foo"

class Foo: ... ... register(Foo, "Foo") # noqa

PARAMETER DESCRIPTION
cls_or_name

The class to register or the name of the class, by default None.

TYPE: Type | str DEFAULT: None

name

The name of the class, by default None

TYPE: str DEFAULT: None

jitclass

Whether to compile the class with numba jitclass, by default False

TYPE: bool DEFAULT: False

spec

The numba jitclass spec, by default None

TYPE: List[Tuple[str, type]] | Mapping[str, type] DEFAULT: None

saveto

The registry to save the class, by default None which will use the default registry

TYPE: Registry DEFAULT: None

methods

The additional methods to add to the class before the jitclass compilation, functions with the first argument being the class instance self

DEFAULT: {}

RETURNS DESCRIPTION
Type | Callable

The class that was registered or a callable that registers the class