API Documentation

desdeo_problem.problem Package

Desdeo-problem package

This package is for creating a problem for desdeo to solve. It includes modules for Variables, Objectives, Constraints, and actual Problem.

Functions

constraint_function_factory(lhs, rhs, operator)	A function that creates an evaluator.
variable_builder(names, initial_values[, ...])	Automatically build all variable objects.

Classes

ScalarConstraint(name, n_decision_vars, ...)	A simple scalar constraint that evaluates to a single scalar.
ConstraintError	Raised when an error related to the Constraint class in encountered.
ConstraintBase()	Base class for constraints.
ObjectiveBase()	The abstract base class for objectives.
ObjectiveError	Raised when an error related to the Objective class is encountered.
ObjectiveEvaluationResults(objectives[, ...])	The return object of <problem>.evaluate methods.
VectorObjectiveBase()	The abstract base class for multiple objectives which are calculated at once.
ScalarObjective(name, evaluator[, ...])	A simple objective function that returns a scalar.
_ScalarObjective(name, evaluator[, ...])
VectorObjective(name, evaluator[, ...])	An objective function vector with one or more objective functions.
ScalarDataObjective(name, data[, evaluator, ...])	A simple Objective class for single valued objectives.
_ScalarDataObjective(name, data[, ...])
VectorDataObjective(name, data[, evaluator, ...])	A Objective class for multi/valued objectives.
ProblemError	Raised when an error related to the Problem class is encountered.
ProblemBase()	The base class for the problems.
EvaluationResults(objectives, fitness[, ...])	The return object of <problem>.evaluate methods.
ScalarMOProblem(objectives, variables, ...)	A multiobjective optimization problem.
ScalarDataProblem(decision_vectors, ...)	A problem class for case where the data is pre-computed.
MOProblem(objectives, variables[, ...])	An user defined multiobjective optimization problem.
DataProblem(data, variable_names, ...[, ...])	A class for a data based problem.
ExperimentalProblem(variable_names, ...[, ...])	A problem class for data-based problem.
VariableError	Raised when an error is encountered during the handling of the Variable objects.
VariableBuilderError	Raised when an error is encountered during the handling of the Variable objects.
Variable(name, initial_value[, lower_bound, ...])	Simple variable with a name, initial value and bounds.
DiscreteDataProblem(data, variable_names, ...)	A problem class for data-based problems with discrete values.

Class Inheritance Diagram

digraph inheritance6d2b3d5a8e { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "ConstraintBase" [URL="api/desdeo_problem.problem.ConstraintBase.html#desdeo_problem.problem.ConstraintBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for constraints."]; "ABC" -> "ConstraintBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ConstraintError" [URL="api/desdeo_problem.problem.ConstraintError.html#desdeo_problem.problem.ConstraintError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Raised when an error related to the Constraint class in encountered."]; "DataProblem" [URL="api/desdeo_problem.problem.DataProblem.html#desdeo_problem.problem.DataProblem",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A class for a data based problem."]; "MOProblem" -> "DataProblem" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DiscreteDataProblem" [URL="api/desdeo_problem.problem.DiscreteDataProblem.html#desdeo_problem.problem.DiscreteDataProblem",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A problem class for data-based problems with discrete values."]; "EvaluationResults" [URL="api/desdeo_problem.problem.EvaluationResults.html#desdeo_problem.problem.EvaluationResults",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The return object of <problem>.evaluate methods."]; "ExperimentalProblem" [URL="api/desdeo_problem.problem.ExperimentalProblem.html#desdeo_problem.problem.ExperimentalProblem",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A problem class for data-based problem. This supports surrogate modelling."]; "MOProblem" -> "ExperimentalProblem" [arrowsize=0.5,style="setlinewidth(0.5)"]; "MOProblem" [URL="api/desdeo_problem.problem.MOProblem.html#desdeo_problem.problem.MOProblem",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An user defined multiobjective optimization problem."]; "ProblemBase" -> "MOProblem" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ObjectiveBase" [URL="api/desdeo_problem.problem.ObjectiveBase.html#desdeo_problem.problem.ObjectiveBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The abstract base class for objectives."]; "ABC" -> "ObjectiveBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ObjectiveError" [URL="api/desdeo_problem.problem.ObjectiveError.html#desdeo_problem.problem.ObjectiveError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Raised when an error related to the Objective class is encountered."]; "ObjectiveEvaluationResults" [URL="api/desdeo_problem.problem.ObjectiveEvaluationResults.html#desdeo_problem.problem.ObjectiveEvaluationResults",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The return object of <problem>.evaluate methods."]; "ProblemBase" [URL="api/desdeo_problem.problem.ProblemBase.html#desdeo_problem.problem.ProblemBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The base class for the problems."]; "ABC" -> "ProblemBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ProblemError" [URL="api/desdeo_problem.problem.ProblemError.html#desdeo_problem.problem.ProblemError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Raised when an error related to the Problem class is encountered."]; "ScalarConstraint" [URL="api/desdeo_problem.problem.ScalarConstraint.html#desdeo_problem.problem.ScalarConstraint",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A simple scalar constraint that evaluates to a single scalar."]; "ConstraintBase" -> "ScalarConstraint" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ScalarDataObjective" [URL="api/desdeo_problem.problem.ScalarDataObjective.html#desdeo_problem.problem.ScalarDataObjective",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A simple Objective class for single valued objectives."]; "ScalarObjective" -> "ScalarDataObjective" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ScalarDataProblem" [URL="api/desdeo_problem.problem.ScalarDataProblem.html#desdeo_problem.problem.ScalarDataProblem",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A problem class for case where the data is pre-computed."]; "ProblemBase" -> "ScalarDataProblem" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ScalarMOProblem" [URL="api/desdeo_problem.problem.ScalarMOProblem.html#desdeo_problem.problem.ScalarMOProblem",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A multiobjective optimization problem."]; "ProblemBase" -> "ScalarMOProblem" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ScalarObjective" [URL="api/desdeo_problem.problem.ScalarObjective.html#desdeo_problem.problem.ScalarObjective",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A simple objective function that returns a scalar."]; "ObjectiveBase" -> "ScalarObjective" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Variable" [URL="api/desdeo_problem.problem.Variable.html#desdeo_problem.problem.Variable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Simple variable with a name, initial value and bounds."]; "VariableBuilderError" [URL="api/desdeo_problem.problem.VariableBuilderError.html#desdeo_problem.problem.VariableBuilderError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Raised when an error is encountered during the handling of the"]; "VariableError" [URL="api/desdeo_problem.problem.VariableError.html#desdeo_problem.problem.VariableError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Raised when an error is encountered during the handling of the"]; "VectorDataObjective" [URL="api/desdeo_problem.problem.VectorDataObjective.html#desdeo_problem.problem.VectorDataObjective",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A Objective class for multi/valued objectives. "]; "VectorObjective" -> "VectorDataObjective" [arrowsize=0.5,style="setlinewidth(0.5)"]; "VectorObjective" [URL="api/desdeo_problem.problem.VectorObjective.html#desdeo_problem.problem.VectorObjective",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An objective function vector with one or more objective functions."]; "VectorObjectiveBase" -> "VectorObjective" [arrowsize=0.5,style="setlinewidth(0.5)"]; "VectorObjectiveBase" [URL="api/desdeo_problem.problem.VectorObjectiveBase.html#desdeo_problem.problem.VectorObjectiveBase",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The abstract base class for multiple objectives which are calculated at once."]; "ABC" -> "VectorObjectiveBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "_ScalarDataObjective" [URL="api/desdeo_problem.problem._ScalarDataObjective.html#desdeo_problem.problem._ScalarDataObjective",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ScalarDataObjective" -> "_ScalarDataObjective" [arrowsize=0.5,style="setlinewidth(0.5)"]; "_ScalarObjective" [URL="api/desdeo_problem.problem._ScalarObjective.html#desdeo_problem.problem._ScalarObjective",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ScalarObjective" -> "_ScalarObjective" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

desdeo_problem.testproblems Package

Functions

test_problem_builder(name[, n_of_variables, ...])	Build test problems.
dummy_problem()	An example on how to implement a problem with 3 objectives and 4 variables and no constraints.
car_side_impact([three_obj, var_iv])	Car-side impact problem.
re21([var_iv])	Four bar truss design problem.
re22([var_iv])	Reinforced concrete beam design problem.
re23([var_iv])	Pressure vesssel design problem.
re24([var_iv])	Hatch cover design problem.
re25([var_iv])	Coil compression spring design problem.
re31([var_iv])	Two bar truss design problem.
re32([var_iv])	Welded beam design problem.
re33([var_iv])	Disc brake design problem.
gaa([var_iv])	The General Aviation Aircraft (GAA) problem.
multiple_clutch_brakes([var_iv])	Multiple clutch brake problem.
river_pollution_problem([five_obj, var_iv])	The river pollution problem with 4 or 5 objectives.
vehicle_crashworthiness([var_iv])	The crash safety design problem with 3 objectives.

desdeo_problem.surrogatemodels Package

Classes

ModelError	Raised when an error related to the surrogate models classes is encountered.
BaseRegressor()
GaussianProcessRegressor(**kwargs)
LipschitzianRegressor([L])

Class Inheritance Diagram

digraph inheritance32fd49c47f { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "BaseEstimator" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for all estimators in scikit-learn."]; "BaseRegressor" [URL="api/desdeo_problem.surrogatemodels.BaseRegressor.html#desdeo_problem.surrogatemodels.BaseRegressor",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ABC" -> "BaseRegressor" [arrowsize=0.5,style="setlinewidth(0.5)"]; "GaussianProcessRegressor" [URL="api/desdeo_problem.surrogatemodels.GaussianProcessRegressor.html#desdeo_problem.surrogatemodels.GaussianProcessRegressor",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "GaussianProcessRegressor" -> "GaussianProcessRegressor" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseRegressor" -> "GaussianProcessRegressor" [arrowsize=0.5,style="setlinewidth(0.5)"]; "GaussianProcessRegressor" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Gaussian process regression (GPR)."]; "MultiOutputMixin" -> "GaussianProcessRegressor" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RegressorMixin" -> "GaussianProcessRegressor" [arrowsize=0.5,style="setlinewidth(0.5)"]; "BaseEstimator" -> "GaussianProcessRegressor" [arrowsize=0.5,style="setlinewidth(0.5)"]; "LipschitzianRegressor" [URL="api/desdeo_problem.surrogatemodels.LipschitzianRegressor.html#desdeo_problem.surrogatemodels.LipschitzianRegressor",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "BaseRegressor" -> "LipschitzianRegressor" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ModelError" [URL="api/desdeo_problem.surrogatemodels.ModelError.html#desdeo_problem.surrogatemodels.ModelError",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Raised when an error related to the surrogate models classes is encountered."]; "MultiOutputMixin" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Mixin to mark estimators that support multioutput."]; "RegressorMixin" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Mixin class for all regression estimators in scikit-learn."]; }