moptipy package¶
moptipy is the Metaheuristic Optimization in Python Package.
This is the basic package of our moptipy project. It provides several sub-packages:
moptipy.algorithmshosts implementations of several metaheuristic optimization algorithmsmoptipy.apidefines the API for implementing optimization algorithms and -problemsmoptipy.evaluationoffers evaluation utilities for the results of experimentsmoptipy.moprovides utilities for multi-objective optimizationmoptipy.operatorsimplements search operators for various search spacesmoptipy.spacesincludes several pre-defined search spacesmoptipy.testsprovides several unit tests for moptipy componentsmoptipy.utilshas utility classes for, e.g., logging and naming
Subpackages¶
- moptipy.algorithms package
- Subpackages
- moptipy.algorithms.mo package
- moptipy.algorithms.modules package
- moptipy.algorithms.so package
- Subpackages
- Submodules
- moptipy.algorithms.so.ea module
- moptipy.algorithms.so.fitness module
- moptipy.algorithms.so.general_ea module
- moptipy.algorithms.so.general_ma module
- moptipy.algorithms.so.greedy_2plus1_ea_mod module
- moptipy.algorithms.so.hill_climber module
- moptipy.algorithms.so.hill_climber_with_restarts module
- moptipy.algorithms.so.ma module
- moptipy.algorithms.so.marls module
- moptipy.algorithms.so.ppa module
- moptipy.algorithms.so.record module
- moptipy.algorithms.so.rls module
- moptipy.algorithms.so.simulated_annealing module
- Submodules
- moptipy.algorithms.luby_restarts module
- moptipy.algorithms.random_sampling module
- moptipy.algorithms.random_walk module
- moptipy.algorithms.restarts module
- moptipy.algorithms.single_random_sample module
- Subpackages
- moptipy.api package
- Submodules
- moptipy.api.algorithm module
- moptipy.api.component module
- moptipy.api.encoding module
- moptipy.api.execution module
ExecutionExecution.execute()Execution.set_algorithm()Execution.set_encoding()Execution.set_goal_f()Execution.set_log_all_fes()Execution.set_log_file()Execution.set_log_improvements()Execution.set_max_fes()Execution.set_max_time_millis()Execution.set_objective()Execution.set_rand_seed()Execution.set_search_space()Execution.set_solution_space()
- moptipy.api.experiment module
- moptipy.api.logging module
ERROR_SECTION_PREFIXFILE_SUFFIXKEY_ALGORITHMKEY_ARCHIVE_FKEY_ARCHIVE_MAX_SIZEKEY_ARCHIVE_PRUNE_LIMITKEY_ARCHIVE_SIZEKEY_BEST_FKEY_BEST_FSKEY_CLASSKEY_COMMAND_LINEKEY_CPU_AFFINITYKEY_EXCEPTION_STACK_TRACEKEY_EXCEPTION_TYPEKEY_EXCEPTION_VALUEKEY_F_LOWER_BOUNDKEY_F_UPPER_BOUNDKEY_GOAL_FKEY_HW_BYTE_ORDERKEY_HW_CPU_MHZKEY_HW_CPU_NAMEKEY_HW_MACHINEKEY_HW_MEM_SIZEKEY_HW_N_LOGICAL_CPUSKEY_HW_N_PHYSICAL_CPUSKEY_INNER_CLASSKEY_INSTANCEKEY_LAST_IMPROVEMENT_FEKEY_LAST_IMPROVEMENT_TIME_MILLISKEY_MAX_FESKEY_MAX_TIME_MILLISKEY_NAMEKEY_NODE_IPKEY_NODE_NAMEKEY_OS_NAMEKEY_OS_RELEASEKEY_OS_VERSIONKEY_PROCESS_IDKEY_PYTHON_IMPLEMENTATIONKEY_PYTHON_VERSIONKEY_RAND_BIT_GENERATOR_TYPEKEY_RAND_GENERATOR_TYPEKEY_RAND_SEEDKEY_SESSION_STARTKEY_SPACE_NUM_VARSKEY_TOTAL_FESKEY_TOTAL_TIME_MILLISKEY_WORKING_DIRECTORYPREFIX_SECTION_ARCHIVEPROGRESS_CURRENT_FPROGRESS_FESPROGRESS_TIME_MILLISSCOPE_ALGORITHMSCOPE_ENCODINGSCOPE_HARDWARESCOPE_OBJECTIVE_FUNCTIONSCOPE_OP0SCOPE_OP1SCOPE_OP2SCOPE_OSSCOPE_PROCESSSCOPE_PRUNERSCOPE_PYTHONSCOPE_SEARCH_SPACESCOPE_SESSIONSCOPE_SOLUTION_SPACESCOPE_VERSIONSSECTION_ARCHIVE_QUALITYSECTION_ERROR_BEST_FSECTION_ERROR_INVALID_XSECTION_ERROR_INVALID_YSECTION_ERROR_IN_CONTEXTSECTION_ERROR_IN_LOGSECTION_ERROR_IN_RUNSECTION_ERROR_TIMINGSECTION_FINAL_STATESECTION_PROGRESSSECTION_RESULT_XSECTION_RESULT_YSECTION_SETUPSECTION_SYS_INFOSUFFIX_SECTION_ARCHIVE_XSUFFIX_SECTION_ARCHIVE_Y
- moptipy.api.mo_algorithm module
- moptipy.api.mo_archive module
- moptipy.api.mo_execution module
- moptipy.api.mo_problem module
- moptipy.api.mo_process module
- moptipy.api.mo_utils module
- moptipy.api.objective module
- moptipy.api.operators module
- moptipy.api.process module
ProcessProcess.add_log_section()Process.evaluate()Process.get_best_f()Process.get_consumed_fes()Process.get_consumed_time_millis()Process.get_copy_of_best_x()Process.get_copy_of_best_y()Process.get_last_improvement_fe()Process.get_last_improvement_time_millis()Process.get_log_basename()Process.get_max_fes()Process.get_max_time_millis()Process.get_random()Process.has_best()Process.has_log()Process.initialize()Process.register()Process.should_terminate()Process.terminate()
check_goal_f()check_max_fes()check_max_time_millis()
- moptipy.api.space module
- moptipy.api.subprocesses module
- moptipy.evaluation package
- Submodules
- moptipy.evaluation.axis_ranger module
- moptipy.evaluation.base module
DESC_ALGORITHMDESC_ENCODINGDESC_INSTANCEDESC_OBJECTIVE_FUNCTIONEvaluationDataElementF_NAME_NORMALIZEDF_NAME_RAWF_NAME_SCALEDKEY_ENCODINGKEY_NKEY_OBJECTIVE_FUNCTIONMultiRun2DDataMultiRunDataPerRunDataTIME_UNIT_FESTIME_UNIT_MILLIScheck_f_name()check_time_unit()get_algorithm()get_instance()motipy_footer_bottom_comments()sort_key()
- moptipy.evaluation.ecdf module
- moptipy.evaluation.end_results module
CsvReaderCsvWriterDESC_BEST_FDESC_GOAL_FDESC_LAST_IMPROVEMENT_FEDESC_LAST_IMPROVEMENT_TIME_MILLISDESC_MAX_FESDESC_MAX_TIME_MILLISDESC_RAND_SEEDDESC_TOTAL_FESDESC_TOTAL_TIME_MILLISEndResultEndResult.best_fEndResult.get_best_f()EndResult.get_fes_per_time_milli()EndResult.get_goal_f()EndResult.get_last_improvement_fe()EndResult.get_last_improvement_time_millis()EndResult.get_max_fes()EndResult.get_max_time_millis()EndResult.get_normalized_best_f()EndResult.get_scaled_best_f()EndResult.get_total_fes()EndResult.get_total_time_millis()EndResult.goal_fEndResult.last_improvement_feEndResult.last_improvement_time_millisEndResult.max_fesEndResult.max_time_millisEndResult.success()EndResult.total_fesEndResult.total_time_millis
EndResultLogParserTfrom_csv()from_logs()getter()to_csv()
- moptipy.evaluation.end_statistics module
CsvReaderCsvWriterEndStatisticsEndStatistics.best_fEndStatistics.best_f_scaledEndStatistics.ert_fesEndStatistics.ert_time_millisEndStatistics.get_best_f()EndStatistics.get_best_f_scaled()EndStatistics.get_ert_fes()EndStatistics.get_ert_time_millis()EndStatistics.get_goal_f()EndStatistics.get_last_improvement_fe()EndStatistics.get_last_improvement_time_millis()EndStatistics.get_max_fes()EndStatistics.get_max_time_millis()EndStatistics.get_n()EndStatistics.get_n_success()EndStatistics.get_success_fes()EndStatistics.get_success_time_millis()EndStatistics.get_total_fes()EndStatistics.get_total_time_millis()EndStatistics.goal_fEndStatistics.last_improvement_feEndStatistics.last_improvement_time_millisEndStatistics.max_fesEndStatistics.max_time_millisEndStatistics.n_successEndStatistics.success_fesEndStatistics.success_time_millisEndStatistics.total_fesEndStatistics.total_time_millis
KEY_BEST_F_SCALEDKEY_ERT_FESKEY_ERT_TIME_MILLISKEY_N_SUCCESSKEY_SUCCESS_FESKEY_SUCCESS_TIME_MILLISaggregate_over_parameter()create()from_csv()from_end_results()getter()to_csv()
- moptipy.evaluation.ert module
- moptipy.evaluation.ertecdf module
- moptipy.evaluation.ioh_analyzer module
- moptipy.evaluation.log_parser module
ExperimentParserLogParserSetupAndStateParserSetupAndStateParser.best_fSetupAndStateParser.encodingSetupAndStateParser.goal_fSetupAndStateParser.last_improvement_feSetupAndStateParser.last_improvement_time_millisSetupAndStateParser.max_fesSetupAndStateParser.max_time_millisSetupAndStateParser.objectiveSetupAndStateParser.total_fesSetupAndStateParser.total_time_millis
T
- moptipy.evaluation.plot_ecdf module
- moptipy.evaluation.plot_end_results module
- moptipy.evaluation.plot_end_statistics_over_parameter module
- moptipy.evaluation.plot_ert module
- moptipy.evaluation.plot_progress module
- moptipy.evaluation.progress module
- moptipy.evaluation.selector module
- moptipy.evaluation.stat_run module
- moptipy.evaluation.styler module
- moptipy.evaluation.tabulate_end_results module
- moptipy.evaluation.tabulate_end_stats module
- moptipy.evaluation.tabulate_result_tests module
- moptipy.examples package
- Subpackages
- moptipy.examples.bitstrings package
default_instances()- Submodules
- moptipy.examples.bitstrings.binint module
- moptipy.examples.bitstrings.bitstring_problem module
- moptipy.examples.bitstrings.ising1d module
- moptipy.examples.bitstrings.ising2d module
- moptipy.examples.bitstrings.jump module
- moptipy.examples.bitstrings.labs module
- moptipy.examples.bitstrings.leadingones module
- moptipy.examples.bitstrings.linearharmonic module
- moptipy.examples.bitstrings.nqueens module
- moptipy.examples.bitstrings.onemax module
- moptipy.examples.bitstrings.plateau module
- moptipy.examples.bitstrings.trap module
- moptipy.examples.bitstrings.twomax module
- moptipy.examples.bitstrings.w_model module
- moptipy.examples.bitstrings.zeromax module
- moptipy.examples.jssp package
- Submodules
- moptipy.examples.jssp.demo_examples module
- moptipy.examples.jssp.evaluation module
- moptipy.examples.jssp.experiment module
- moptipy.examples.jssp.gantt module
- moptipy.examples.jssp.gantt_space module
- moptipy.examples.jssp.instance module
- moptipy.examples.jssp.instance_selector module
- moptipy.examples.jssp.makespan module
- moptipy.examples.jssp.ob_encoding module
- moptipy.examples.jssp.plot_gantt_chart module
- moptipy.examples.jssp.plots module
- moptipy.examples.jssp.spaces_sizes module
- moptipy.examples.jssp.worktime module
- moptipy.examples.vectors package
- moptipy.examples.bitstrings package
- Subpackages
- moptipy.mo package
- moptipy.mock package
- Submodules
- moptipy.mock.components module
AlgorithmBasePerformanceExperimentExperiment.algorithm_applications()Experiment.algorithm_namesExperiment.algorithmsExperiment.applicationsExperiment.create()Experiment.get_algorithm()Experiment.get_instance()Experiment.instance_applications()Experiment.instance_namesExperiment.instancesExperiment.per_instance_seedsExperiment.seeds_for_instance()
Instancefixed_random_generator()get_run_seeds()
- moptipy.mock.end_results module
- moptipy.mock.mo_problem module
- moptipy.mock.objective module
MockObjectiveMockObjective.evaluate()MockObjective.fattractorsMockObjective.fmaxMockObjective.fminMockObjective.for_type()MockObjective.is_always_integer()MockObjective.is_intMockObjective.lbMockObjective.log_parameters_to()MockObjective.lower_bound()MockObjective.nameMockObjective.sample()MockObjective.seedMockObjective.ubMockObjective.upper_bound()
- moptipy.mock.utils module
- moptipy.operators package
- Subpackages
- moptipy.operators.bitstrings package
- moptipy.operators.ordered_choices package
- moptipy.operators.permutations package
- Submodules
- moptipy.operators.permutations.op0_shuffle module
- moptipy.operators.permutations.op1_insert1 module
- moptipy.operators.permutations.op1_swap2 module
- moptipy.operators.permutations.op1_swap_exactly_n module
- moptipy.operators.permutations.op1_swap_try_n module
- moptipy.operators.permutations.op1_swapn module
- moptipy.operators.permutations.op2_gap module
- moptipy.operators.permutations.op2_ox2 module
- moptipy.operators.signed_permutations package
- moptipy.operators.vectors package
- Submodules
- moptipy.operators.op0_forward module
- moptipy.operators.tools module
- Subpackages
- moptipy.spaces package
- Submodules
- moptipy.spaces.bitstrings module
- moptipy.spaces.intspace module
- moptipy.spaces.nparrayspace module
- moptipy.spaces.ordered_choices module
- moptipy.spaces.permutations module
- moptipy.spaces.signed_permutations module
KEY_UNSIGNED_MINSignedPermutationsSignedPermutations.blueprintSignedPermutations.create()SignedPermutations.has_repetitions()SignedPermutations.is_dense()SignedPermutations.log_parameters_to()SignedPermutations.n()SignedPermutations.n_points()SignedPermutations.standard()SignedPermutations.unsigned_min_valueSignedPermutations.validate()SignedPermutations.with_repetitions()
- moptipy.spaces.vectorspace module
- moptipy.tests package
- Submodules
- moptipy.tests.algorithm module
- moptipy.tests.component module
- moptipy.tests.encoding module
- moptipy.tests.fitness module
- moptipy.tests.mo_algorithm module
- moptipy.tests.mo_archive_pruner module
- moptipy.tests.mo_problem module
- moptipy.tests.objective module
- moptipy.tests.on_bitstrings module
bitstrings_for_tests()dimensions_for_tests()random_bit_string()validate_algorithm_on_bitstrings()validate_algorithm_on_leadingones()validate_algorithm_on_onemax()validate_fitness_on_bitstrings()validate_mo_algorithm_on_2_bitstring_problems()validate_mo_algorithm_on_3_bitstring_problems()validate_mo_algorithm_on_bitstrings()validate_op0_on_1_bitstrings()validate_op0_on_bitstrings()validate_op1_on_1_bitstrings()validate_op1_on_bitstrings()validate_op1_with_step_size_on_1_bitstrings()validate_op1_with_step_size_on_bitstrings()validate_op2_on_1_bitstrings()validate_op2_on_bitstrings()verify_algorithms_equivalent()
- moptipy.tests.on_jssp module
- moptipy.tests.on_ordered_choices module
- moptipy.tests.on_permutations module
make_permutation_valid()permutations_for_tests()validate_op0_on_1_permutations()validate_op0_on_permutations()validate_op1_on_1_permutations()validate_op1_on_permutations()validate_op1_with_step_size_on_1_permutations()validate_op1_with_step_size_on_permutations()validate_op2_on_1_permutations()validate_op2_on_permutations()
- moptipy.tests.on_signed_permutations module
- moptipy.tests.on_vectors module
- moptipy.tests.op0 module
- moptipy.tests.op1 module
- moptipy.tests.op1_with_step_size module
- moptipy.tests.op2 module
- moptipy.tests.selection module
- moptipy.tests.space module
- moptipy.utils package
- Submodules
- moptipy.utils.formatted_string module
- moptipy.utils.help module
- moptipy.utils.html module
- moptipy.utils.lang module
- moptipy.utils.latex module
- moptipy.utils.logger module
- moptipy.utils.markdown module
- moptipy.utils.math module
- moptipy.utils.nputils module
DEFAULT_BOOLDEFAULT_FLOATDEFAULT_INTDEFAULT_NUMERICALDEFAULT_UNSIGNED_INTINTSKEY_NUMPY_TYPEarray_to_str()dtype_for_data()fill_in_canonical_permutation()int_range_to_dtype()is_all_finite()is_np_float()is_np_int()np_ints_max()np_to_py_number()numpy_type_to_str()rand_generator()rand_seed_check()rand_seed_generate()rand_seeds_from_str()
- moptipy.utils.number_renderer module
- moptipy.utils.plot_defaults module
- moptipy.utils.plot_utils module
- moptipy.utils.strings module
- moptipy.utils.sys_info module
- moptipy.utils.table module
- moptipy.utils.text_format module
MODE_NORMALMODE_SECTION_HEADERMODE_TABLE_HEADERTextFormatDriverTextFormatDriver.begin_table_body()TextFormatDriver.begin_table_cell()TextFormatDriver.begin_table_header()TextFormatDriver.begin_table_row()TextFormatDriver.begin_table_section()TextFormatDriver.begin_table_section_header()TextFormatDriver.end_table_body()TextFormatDriver.end_table_cell()TextFormatDriver.end_table_header()TextFormatDriver.end_table_row()TextFormatDriver.end_table_section()TextFormatDriver.end_table_section_header()TextFormatDriver.filename()TextFormatDriver.text()
Submodules¶
moptipy.version module¶
An internal file with the version of the moptipy package.