NiaPy’s documentation¶
Python micro framework for building nature-inspired algorithms.
Nature-inspired algorithms are a very popular tool for solving optimization problems. Since the beginning of their era, numerous variants of nature-inspired algorithms were developed (paper 1, paper 2). To prove their versatility, those were tested in various domains on various applications, especially when they are hybridized, modified or adapted. However, implementation of nature-inspired algorithms is sometimes difficult, complex and tedious task. In order to break this wall, NiaPy is intended for simple and quick use, without spending a time for implementing algorithms from scratch.
Free software: MIT license
Github repository: https://github.com/NiaOrg/NiaPy
Python versions: 3.6.x, 3.7.x, 3.8.x, 3.9.x
The main documentation is organized into a couple sections:
General
- About
- Features
- Credits
- Changelog
- 2.0.5 (2023-03-26)
- 2.0.4 (2022-11-20)
- 2.0.3 (2022-09-03)
- 2.0.2 (2022-05-22)
- 2.0.1 (2022-03-05)
- 2.0.0 (2021-12-27)
- 2.0.0rc18 (2021-08-18)
- 2.0.0rc17 (2021-06-10)
- 2.0.0rc16 (2021-05-26)
- 2.0.0rc15 (2021-05-14)
- 2.0.0rc14 (2021-04-23)
- 2.0.0rc13 (2021-03-10)
- 2.0.0rc12 (2020-12-04)
- 2.0.0rc11 (2020-07-19)
- 2.0.0rc10 (2019-11-12)
- 2.0.0rc9 (2019-11-11)
- 2.0.0rc8 (2019-11-11)
- 2.0.0rc7 (2019-11-11)
- 2.0.0rc6 (2019-11-11)
- 2.0.0rc5 (2019-05-06)
- 2.0.0rc4 (2018-11-30)
- 2.0.0rc3 (2018-11-30)
- 1.0.2 (2018-10-24)
- 2 (2018-08-30)
- 2.0.0rc2 (2018-08-30)
- 2.0.0rc1 (2018-08-30)
- 1.0.1 (2018-03-21)
- 1.0.0 (2018-02-28)
- 1.0.0rc2 (2018-02-28)
- 1.0.0rc1 (2018-02-28)
- 0.1.3a2 (2018-02-26)
- 0.1.3a1 (2018-02-26)
- 0.1.2a4 (2018-02-26)
- 0.1.2a3 (2018-02-26)
- 0.1.2a2 (2018-02-26)
- 0.1.2a1 (2018-02-26)
- Code of Conduct
User Documentation
Developer Documentation
API Documentation
- API Documentation
niapyniapy.algorithmsAlgorithmAlgorithm.NameAlgorithm.__init__()Algorithm.bad_run()Algorithm.get_best()Algorithm.get_parameters()Algorithm.info()Algorithm.init_population()Algorithm.integers()Algorithm.iteration_generator()Algorithm.normal()Algorithm.random()Algorithm.run()Algorithm.run_iteration()Algorithm.run_task()Algorithm.set_parameters()Algorithm.standard_normal()Algorithm.uniform()
Individualdefault_individual_init()default_numpy_init()niapy.algorithms.basicAgingNpDifferentialEvolutionAgingNpDifferentialEvolution.NameAgingNpDifferentialEvolution.__init__()AgingNpDifferentialEvolution.aging()AgingNpDifferentialEvolution.decrement_population()AgingNpDifferentialEvolution.delta_pop_created()AgingNpDifferentialEvolution.delta_pop_eliminated()AgingNpDifferentialEvolution.get_parameters()AgingNpDifferentialEvolution.increment_population()AgingNpDifferentialEvolution.info()AgingNpDifferentialEvolution.post_selection()AgingNpDifferentialEvolution.selection()AgingNpDifferentialEvolution.set_parameters()
ArtificialBeeColonyAlgorithmArtificialBeeColonyAlgorithm.NameArtificialBeeColonyAlgorithm.__init__()ArtificialBeeColonyAlgorithm.calculate_probabilities()ArtificialBeeColonyAlgorithm.get_parameters()ArtificialBeeColonyAlgorithm.info()ArtificialBeeColonyAlgorithm.init_population()ArtificialBeeColonyAlgorithm.run_iteration()ArtificialBeeColonyAlgorithm.set_parameters()
BacterialForagingOptimizationBacterialForagingOptimization.NameBacterialForagingOptimization.__init__()BacterialForagingOptimization.get_parameters()BacterialForagingOptimization.info()BacterialForagingOptimization.init_population()BacterialForagingOptimization.interaction()BacterialForagingOptimization.random_direction()BacterialForagingOptimization.run_iteration()BacterialForagingOptimization.set_parameters()
BareBonesFireworksAlgorithmBatAlgorithmBeesAlgorithmCamelAlgorithmCatSwarmOptimizationCatSwarmOptimization.NameCatSwarmOptimization.__init__()CatSwarmOptimization.get_parameters()CatSwarmOptimization.info()CatSwarmOptimization.init_population()CatSwarmOptimization.random_seek_trace()CatSwarmOptimization.run_iteration()CatSwarmOptimization.seeking_mode()CatSwarmOptimization.set_parameters()CatSwarmOptimization.tracing_mode()CatSwarmOptimization.weighted_selection()
CenterParticleSwarmOptimizationClonalSelectionAlgorithmClonalSelectionAlgorithm.NameClonalSelectionAlgorithm.__init__()ClonalSelectionAlgorithm.clone_and_hypermutate()ClonalSelectionAlgorithm.decode()ClonalSelectionAlgorithm.evaluate()ClonalSelectionAlgorithm.get_parameters()ClonalSelectionAlgorithm.info()ClonalSelectionAlgorithm.init_population()ClonalSelectionAlgorithm.mutate()ClonalSelectionAlgorithm.random_insertion()ClonalSelectionAlgorithm.run_iteration()ClonalSelectionAlgorithm.set_parameters()
ComprehensiveLearningParticleSwarmOptimizerComprehensiveLearningParticleSwarmOptimizer.NameComprehensiveLearningParticleSwarmOptimizer.__init__()ComprehensiveLearningParticleSwarmOptimizer.generate_personal_best_cl()ComprehensiveLearningParticleSwarmOptimizer.get_parameters()ComprehensiveLearningParticleSwarmOptimizer.info()ComprehensiveLearningParticleSwarmOptimizer.init()ComprehensiveLearningParticleSwarmOptimizer.run_iteration()ComprehensiveLearningParticleSwarmOptimizer.set_parameters()ComprehensiveLearningParticleSwarmOptimizer.update_velocity_cl()
CoralReefsOptimizationCoralReefsOptimization.NameCoralReefsOptimization.__init__()CoralReefsOptimization.asexual_reproduction()CoralReefsOptimization.depredation()CoralReefsOptimization.get_parameters()CoralReefsOptimization.info()CoralReefsOptimization.run_iteration()CoralReefsOptimization.set_parameters()CoralReefsOptimization.settling()
CuckooSearchDifferentialEvolutionDifferentialEvolution.NameDifferentialEvolution.__init__()DifferentialEvolution.evolve()DifferentialEvolution.get_parameters()DifferentialEvolution.info()DifferentialEvolution.post_selection()DifferentialEvolution.run_iteration()DifferentialEvolution.selection()DifferentialEvolution.set_parameters()
DynNpDifferentialEvolutionDynNpMultiStrategyDifferentialEvolutionDynNpMultiStrategyDifferentialEvolution.NameDynNpMultiStrategyDifferentialEvolution.evolve()DynNpMultiStrategyDifferentialEvolution.get_parameters()DynNpMultiStrategyDifferentialEvolution.info()DynNpMultiStrategyDifferentialEvolution.post_selection()DynNpMultiStrategyDifferentialEvolution.set_parameters()
DynamicFireworksAlgorithmDynamicFireworksAlgorithmGaussDynamicFireworksAlgorithmGauss.NameDynamicFireworksAlgorithmGauss.__init__()DynamicFireworksAlgorithmGauss.explosion_amplitudes()DynamicFireworksAlgorithmGauss.get_parameters()DynamicFireworksAlgorithmGauss.info()DynamicFireworksAlgorithmGauss.init_population()DynamicFireworksAlgorithmGauss.run_iteration()DynamicFireworksAlgorithmGauss.selection()DynamicFireworksAlgorithmGauss.set_parameters()DynamicFireworksAlgorithmGauss.update_cf()
EnhancedFireworksAlgorithmEnhancedFireworksAlgorithm.NameEnhancedFireworksAlgorithm.__init__()EnhancedFireworksAlgorithm.explosion_amplitudes()EnhancedFireworksAlgorithm.explosion_spark()EnhancedFireworksAlgorithm.gaussian_spark()EnhancedFireworksAlgorithm.get_parameters()EnhancedFireworksAlgorithm.info()EnhancedFireworksAlgorithm.mapping()EnhancedFireworksAlgorithm.selection()EnhancedFireworksAlgorithm.set_parameters()
EvolutionStrategy1p1EvolutionStrategy1p1.NameEvolutionStrategy1p1.__init__()EvolutionStrategy1p1.get_parameters()EvolutionStrategy1p1.info()EvolutionStrategy1p1.init_population()EvolutionStrategy1p1.mutate()EvolutionStrategy1p1.run_iteration()EvolutionStrategy1p1.set_parameters()EvolutionStrategy1p1.update_rho()
EvolutionStrategyMLEvolutionStrategyMp1EvolutionStrategyMpLEvolutionStrategyMpL.NameEvolutionStrategyMpL.__init__()EvolutionStrategyMpL.change_count()EvolutionStrategyMpL.get_parameters()EvolutionStrategyMpL.info()EvolutionStrategyMpL.init_population()EvolutionStrategyMpL.mutate_rand()EvolutionStrategyMpL.run_iteration()EvolutionStrategyMpL.set_parameters()EvolutionStrategyMpL.update_rho()
FireflyAlgorithmFireworksAlgorithmFireworksAlgorithm.NameFireworksAlgorithm.__init__()FireworksAlgorithm.explosion_amplitudes()FireworksAlgorithm.explosion_spark()FireworksAlgorithm.gaussian_spark()FireworksAlgorithm.get_parameters()FireworksAlgorithm.info()FireworksAlgorithm.mapping()FireworksAlgorithm.run_iteration()FireworksAlgorithm.selection()FireworksAlgorithm.set_parameters()FireworksAlgorithm.sparks_num()
FishSchoolSearchFishSchoolSearch.NameFishSchoolSearch.__init__()FishSchoolSearch.collective_instinctive_movement()FishSchoolSearch.collective_volitive_movement()FishSchoolSearch.feeding()FishSchoolSearch.get_parameters()FishSchoolSearch.individual_movement()FishSchoolSearch.info()FishSchoolSearch.init_population()FishSchoolSearch.init_school()FishSchoolSearch.run_iteration()FishSchoolSearch.set_parameters()FishSchoolSearch.update_steps()
FlowerPollinationAlgorithmForestOptimizationAlgorithmForestOptimizationAlgorithm.NameForestOptimizationAlgorithm.__init__()ForestOptimizationAlgorithm.get_parameters()ForestOptimizationAlgorithm.global_seeding()ForestOptimizationAlgorithm.info()ForestOptimizationAlgorithm.init_population()ForestOptimizationAlgorithm.local_seeding()ForestOptimizationAlgorithm.remove_lifetime_exceeded()ForestOptimizationAlgorithm.run_iteration()ForestOptimizationAlgorithm.set_parameters()ForestOptimizationAlgorithm.survival_of_the_fittest()
GeneticAlgorithmGlowwormSwarmOptimizationGlowwormSwarmOptimization.NameGlowwormSwarmOptimization.__init__()GlowwormSwarmOptimization.calculate_luciferin()GlowwormSwarmOptimization.get_neighbors()GlowwormSwarmOptimization.get_parameters()GlowwormSwarmOptimization.info()GlowwormSwarmOptimization.init_population()GlowwormSwarmOptimization.move_select()GlowwormSwarmOptimization.probabilities()GlowwormSwarmOptimization.range_update()GlowwormSwarmOptimization.run_iteration()GlowwormSwarmOptimization.set_parameters()
GlowwormSwarmOptimizationV1GlowwormSwarmOptimizationV2GlowwormSwarmOptimizationV3GravitationalSearchAlgorithmGravitationalSearchAlgorithm.NameGravitationalSearchAlgorithm.__init__()GravitationalSearchAlgorithm.get_parameters()GravitationalSearchAlgorithm.gravity()GravitationalSearchAlgorithm.info()GravitationalSearchAlgorithm.init_population()GravitationalSearchAlgorithm.run_iteration()GravitationalSearchAlgorithm.set_parameters()
GreyWolfOptimizerHarmonySearchHarmonySearchV1HarrisHawksOptimizationKrillHerdKrillHerd.NameKrillHerd.__init__()KrillHerd.crossover()KrillHerd.crossover_rate()KrillHerd.delta_t()KrillHerd.get_food_location()KrillHerd.get_k()KrillHerd.get_neighbours()KrillHerd.get_parameters()KrillHerd.get_x()KrillHerd.induce_foraging_motion()KrillHerd.induce_neighbors_motion()KrillHerd.induce_physical_diffusion()KrillHerd.info()KrillHerd.init_population()KrillHerd.init_weights()KrillHerd.mutate()KrillHerd.mutation_rate()KrillHerd.run_iteration()KrillHerd.sense_range()KrillHerd.set_parameters()
LionOptimizationAlgorithmLionOptimizationAlgorithm.NameLionOptimizationAlgorithm.__init__()LionOptimizationAlgorithm.data_correction()LionOptimizationAlgorithm.defense()LionOptimizationAlgorithm.get_parameters()LionOptimizationAlgorithm.hunting()LionOptimizationAlgorithm.info()LionOptimizationAlgorithm.init_population()LionOptimizationAlgorithm.init_population_data()LionOptimizationAlgorithm.mating()LionOptimizationAlgorithm.migration()LionOptimizationAlgorithm.move_to_safe_place()LionOptimizationAlgorithm.population_equilibrium()LionOptimizationAlgorithm.roaming()LionOptimizationAlgorithm.run_iteration()LionOptimizationAlgorithm.set_parameters()
MonarchButterflyOptimizationMonarchButterflyOptimization.NameMonarchButterflyOptimization.__init__()MonarchButterflyOptimization.adjusting_operator()MonarchButterflyOptimization.evaluate_and_sort()MonarchButterflyOptimization.get_parameters()MonarchButterflyOptimization.info()MonarchButterflyOptimization.init_population()MonarchButterflyOptimization.levy()MonarchButterflyOptimization.migration_operator()MonarchButterflyOptimization.run_iteration()MonarchButterflyOptimization.set_parameters()
MonkeyKingEvolutionV1MonkeyKingEvolutionV1.NameMonkeyKingEvolutionV1.__init__()MonkeyKingEvolutionV1.get_parameters()MonkeyKingEvolutionV1.info()MonkeyKingEvolutionV1.init_population()MonkeyKingEvolutionV1.move_mk()MonkeyKingEvolutionV1.move_monkey_king_particle()MonkeyKingEvolutionV1.move_p()MonkeyKingEvolutionV1.move_particle()MonkeyKingEvolutionV1.move_population()MonkeyKingEvolutionV1.run_iteration()MonkeyKingEvolutionV1.set_parameters()
MonkeyKingEvolutionV2MonkeyKingEvolutionV3MothFlameOptimizerMultiStrategyDifferentialEvolutionMutatedCenterParticleSwarmOptimizationMutatedCenterParticleSwarmOptimization.NameMutatedCenterParticleSwarmOptimization.__init__()MutatedCenterParticleSwarmOptimization.get_parameters()MutatedCenterParticleSwarmOptimization.info()MutatedCenterParticleSwarmOptimization.run_iteration()MutatedCenterParticleSwarmOptimization.set_parameters()
MutatedCenterUnifiedParticleSwarmOptimizationMutatedParticleSwarmOptimizationOppositionVelocityClampingParticleSwarmOptimizationOppositionVelocityClampingParticleSwarmOptimization.NameOppositionVelocityClampingParticleSwarmOptimization.__init__()OppositionVelocityClampingParticleSwarmOptimization.get_parameters()OppositionVelocityClampingParticleSwarmOptimization.info()OppositionVelocityClampingParticleSwarmOptimization.init_population()OppositionVelocityClampingParticleSwarmOptimization.opposite_learning()OppositionVelocityClampingParticleSwarmOptimization.run_iteration()OppositionVelocityClampingParticleSwarmOptimization.set_parameters()
ParticleSwarmAlgorithmParticleSwarmAlgorithm.NameParticleSwarmAlgorithm.__init__()ParticleSwarmAlgorithm.get_parameters()ParticleSwarmAlgorithm.info()ParticleSwarmAlgorithm.init()ParticleSwarmAlgorithm.init_population()ParticleSwarmAlgorithm.run_iteration()ParticleSwarmAlgorithm.set_parameters()ParticleSwarmAlgorithm.update_velocity()
ParticleSwarmOptimizationSineCosineAlgorithmmulti_mutations()
niapy.algorithms.modifiedAdaptiveBatAlgorithmAdaptiveBatAlgorithm.NameAdaptiveBatAlgorithm.__init__()AdaptiveBatAlgorithm.get_parameters()AdaptiveBatAlgorithm.info()AdaptiveBatAlgorithm.init_population()AdaptiveBatAlgorithm.local_search()AdaptiveBatAlgorithm.run_iteration()AdaptiveBatAlgorithm.set_parameters()AdaptiveBatAlgorithm.update_loudness()
DifferentialEvolutionMTSDifferentialEvolutionMTSv1DynNpDifferentialEvolutionMTSDynNpDifferentialEvolutionMTSv1DynNpMultiStrategyDifferentialEvolutionMTSDynNpMultiStrategyDifferentialEvolutionMTSv1HybridBatAlgorithmHybridSelfAdaptiveBatAlgorithmLpsrSuccessHistoryAdaptiveDifferentialEvolutionMultiStrategyDifferentialEvolutionMTSMultiStrategyDifferentialEvolutionMTSv1MultiStrategySelfAdaptiveDifferentialEvolutionParameterFreeBatAlgorithmSelfAdaptiveBatAlgorithmSelfAdaptiveBatAlgorithm.NameSelfAdaptiveBatAlgorithm.__init__()SelfAdaptiveBatAlgorithm.get_parameters()SelfAdaptiveBatAlgorithm.info()SelfAdaptiveBatAlgorithm.init_population()SelfAdaptiveBatAlgorithm.run_iteration()SelfAdaptiveBatAlgorithm.self_adaptation()SelfAdaptiveBatAlgorithm.set_parameters()
SelfAdaptiveDifferentialEvolutionSelfAdaptiveDifferentialEvolution.NameSelfAdaptiveDifferentialEvolution.__init__()SelfAdaptiveDifferentialEvolution.adaptive_gen()SelfAdaptiveDifferentialEvolution.evolve()SelfAdaptiveDifferentialEvolution.get_parameters()SelfAdaptiveDifferentialEvolution.info()SelfAdaptiveDifferentialEvolution.set_parameters()
SuccessHistoryAdaptiveDifferentialEvolutionSuccessHistoryAdaptiveDifferentialEvolution.NameSuccessHistoryAdaptiveDifferentialEvolution.__init__()SuccessHistoryAdaptiveDifferentialEvolution.cauchy()SuccessHistoryAdaptiveDifferentialEvolution.evolve()SuccessHistoryAdaptiveDifferentialEvolution.gen_ind_params()SuccessHistoryAdaptiveDifferentialEvolution.get_parameters()SuccessHistoryAdaptiveDifferentialEvolution.info()SuccessHistoryAdaptiveDifferentialEvolution.init_population()SuccessHistoryAdaptiveDifferentialEvolution.post_selection()SuccessHistoryAdaptiveDifferentialEvolution.run_iteration()SuccessHistoryAdaptiveDifferentialEvolution.selection()SuccessHistoryAdaptiveDifferentialEvolution.set_parameters()
niapy.algorithms.otherAnarchicSocietyOptimizationAnarchicSocietyOptimization.NameAnarchicSocietyOptimization.__init__()AnarchicSocietyOptimization.external_irregularity()AnarchicSocietyOptimization.fickleness_index()AnarchicSocietyOptimization.get_best_neighbors()AnarchicSocietyOptimization.get_parameters()AnarchicSocietyOptimization.info()AnarchicSocietyOptimization.init()AnarchicSocietyOptimization.init_population()AnarchicSocietyOptimization.irregularity_index()AnarchicSocietyOptimization.run_iteration()AnarchicSocietyOptimization.set_parameters()AnarchicSocietyOptimization.update_personal_best()
HillClimbAlgorithmMultipleTrajectorySearchMultipleTrajectorySearch.NameMultipleTrajectorySearch.__init__()MultipleTrajectorySearch.get_parameters()MultipleTrajectorySearch.grading_run()MultipleTrajectorySearch.info()MultipleTrajectorySearch.init_population()MultipleTrajectorySearch.run_iteration()MultipleTrajectorySearch.run_local_search()MultipleTrajectorySearch.set_parameters()
MultipleTrajectorySearchV1NelderMeadMethodRandomSearchSimulatedAnnealingmts_ls1()mts_ls1v1()mts_ls2()mts_ls3()mts_ls3v1()
niapy.problemsAckleyAlpine1Alpine2BentCigarChungReynoldsCosineMixtureCsendesDiscusDixonPriceEllipticExpandedGriewankPlusRosenbrockExpandedSchafferGriewankHGBatHappyCatKatsuuraLevyMichalewiczModifiedSchwefelPermPinterPowellProblemQingQuinticRastriginRidgeRosenbrockSalomonSchafferN2SchafferN4SchumerSteiglitzSchwefelSchwefel221Schwefel222SphereSphere2Sphere3StepStep2Step3StepintStyblinskiTangSumSquaresTridWeierstrassWhitleyZakharov
niapy.util