algorithms package

Define the optimisation algorithms used for compensation.

When you implement you own algorithm, do not forget to add it in the algorithms.factory module.

Submodules

• algorithm module
  • OptiSol
    • OptiSol.var
    • OptiSol.cavity_settings
    • OptiSol.fun
    • OptiSol.objectives
    • OptiSol.cv
    • OptiSol.constraints
    • OptiSol.success
    • OptiSol.info
  • OptimisationAlgorithm
    • OptimisationAlgorithm.__init__()
    • OptimisationAlgorithm.supports_constraints
    • OptimisationAlgorithm.__str__()
    • OptimisationAlgorithm.variable_names
    • OptimisationAlgorithm.n_var
    • OptimisationAlgorithm.n_obj
    • OptimisationAlgorithm.n_constr
    • OptimisationAlgorithm._default_kwargs
    • OptimisationAlgorithm.optimize()
    • OptimisationAlgorithm._generate_opti_sol()
    • OptimisationAlgorithm._format_variables()
    • OptimisationAlgorithm._format_objectives()
    • OptimisationAlgorithm._format_constraints()
    • OptimisationAlgorithm._wrapper_residuals()
    • OptimisationAlgorithm._norm_wrapper_residuals()
    • OptimisationAlgorithm._finalize()
    • OptimisationAlgorithm._to_cavity_settings()
    • OptimisationAlgorithm._evaluate_solution()
    • OptimisationAlgorithm._check_consistency()
    • OptimisationAlgorithm._abc_impl
  • OptimizationHistory
    • OptimizationHistory._settings_filename
    • OptimizationHistory._objectives_filename
    • OptimizationHistory._constraints_filename
    • OptimizationHistory.__init__()
    • OptimizationHistory._make_public_methods_useless()
    • OptimizationHistory.add_settings()
    • OptimizationHistory._init_objective_hist()
    • OptimizationHistory._simulation_output_to_objectives()
    • OptimizationHistory._objective_headers()
    • OptimizationHistory.add_objective_values()
    • OptimizationHistory.add_constraint_values()
    • OptimizationHistory.save()
    • OptimizationHistory._rename_previous_files()
    • OptimizationHistory._empty_histories()
    • OptimizationHistory.checkpoint()
  • _save_values()
• bayesian_optimization module
  • BayesianOptimizationLW
    • BayesianOptimizationLW.supports_constraints
    • BayesianOptimizationLW.optimize()
    • BayesianOptimizationLW._to_maximise()
    • BayesianOptimizationLW._default_kwargs
    • BayesianOptimizationLW._generate_opti_sol()
    • BayesianOptimizationLW._format_variables()
    • BayesianOptimizationLW._to_numpy()
    • BayesianOptimizationLW.acquisition_function()
    • BayesianOptimizationLW._abc_impl
• differential_evolution module
  • DifferentialEvolution
    • DifferentialEvolution.supports_constraints
    • DifferentialEvolution.optimize()
    • DifferentialEvolution._algorithm_parameters()
    • DifferentialEvolution._abc_impl
• downhill_simplex module
  • DownhillSimplex
    • DownhillSimplex.supports_constraints
    • DownhillSimplex.optimize()
    • DownhillSimplex._default_kwargs
    • DownhillSimplex._generate_opti_sol()
    • DownhillSimplex._format_variables()
    • DownhillSimplex._abc_impl
• downhill_simplex_penalty module
  • DownhillSimplexPenalty
    • DownhillSimplexPenalty.supports_constraints
    • DownhillSimplexPenalty.__init__()
    • DownhillSimplexPenalty._default_kwargs
    • DownhillSimplexPenalty._norm_wrapper_residuals()
    • DownhillSimplexPenalty._penalty()
    • DownhillSimplexPenalty._abc_impl
• explorator module
  • Explorator
    • Explorator.supports_constraints
    • Explorator.compute_constraints
    • Explorator.optimize()
    • Explorator._algorithm_parameters()
    • Explorator._generate_combinations()
    • Explorator._array_of_values_to_mesh()
    • Explorator._generate_opti_sol()
    • Explorator._take_best_solution()
    • Explorator._abc_impl
• factory module
  • ALGORITHM_SELECTOR
  • ALGORITHMS_T
  • OptimisationAlgorithmFactory
    • OptimisationAlgorithmFactory.__init__()
    • OptimisationAlgorithmFactory.create()
    • OptimisationAlgorithmFactory.create_from_preset()
    • OptimisationAlgorithmFactory._make_default_kwargs()
    • OptimisationAlgorithmFactory._log_common_keys()
• least_squares module
  • LeastSquares
    • LeastSquares.supports_constraints
    • LeastSquares.optimize()
    • LeastSquares._default_kwargs
    • LeastSquares._abc_impl
• least_squares_penalty module
  • LeastSquaresPenalty
    • LeastSquaresPenalty.supports_constraints
    • LeastSquaresPenalty.__init__()
    • LeastSquaresPenalty._norm_wrapper_residuals()
    • LeastSquaresPenalty._penalty()
    • LeastSquaresPenalty._abc_impl
• nsga module
  • _LightWinProblem
    • _LightWinProblem.__init__()
    • _LightWinProblem._evaluate()
  • NSGA3Algorithm
    • NSGA3Algorithm.supports_constraints
    • NSGA3Algorithm.optimize()
    • NSGA3Algorithm._default_kwargs
    • NSGA3Algorithm._evaluate_individual()
    • NSGA3Algorithm._generate_opti_sol()
    • NSGA3Algorithm._problem()
    • NSGA3Algorithm._format_variables()
    • NSGA3Algorithm._abc_impl
  • _LightWinProblemMulti
    • _LightWinProblemMulti.__init__()
    • _LightWinProblemMulti._evaluate()
  • NSGA3AlgorithmMulti
    • NSGA3AlgorithmMulti.__init__()
    • NSGA3AlgorithmMulti._default_kwargs
    • NSGA3AlgorithmMulti._evaluate_individual()
    • NSGA3AlgorithmMulti._problem()
    • NSGA3AlgorithmMulti._abc_impl
• predefined_solution module
  • PredefinedSolution
    • PredefinedSolution.supports_constraints
    • PredefinedSolution.__init__()
    • PredefinedSolution.optimize()
    • PredefinedSolution._generate_opti_sol()
    • PredefinedSolution._abc_impl
• simulated_annealing module
  • SimulatedAnnealing
    • SimulatedAnnealing.supports_constraints
    • SimulatedAnnealing.optimize()
    • SimulatedAnnealing._default_kwargs
    • SimulatedAnnealing._generate_opti_sol()
    • SimulatedAnnealing._format_bounds()
    • SimulatedAnnealing._abc_impl