CUSTOMHyS Logo

Getting Started

  • Getting Started
    • Prerequisites
    • A Minimal Example
    • Running a Hyper-Heuristic
    • Running a Full Experiment
    • What’s Next?
  • Installation
    • Core Installation
    • Optional Extras
      • Machine Learning support
      • Development tools
      • Jupyter / Notebook examples
      • Documentation building
      • Everything at once
    • Development Installation (from source)
    • Apple Silicon (M1 / M2 / M3) Note
    • Python Version Support

User Guide

  • User Guide
    • Architecture
      • Module Overview
        • 🤯 Benchmark Functions (benchmark_func)
        • 👯‍♂️ Population (population)
        • 🦾 Search Operators (operators)
        • 🤖 Metaheuristic (metaheuristic)
        • 👽 Hyper-heuristic (hyperheuristic)
        • 🏭 Experiment (experiment)
        • 🗜️ Tools (tools)
        • 🧠 Machine Learning (machine_learning)
        • 🌡️ Characterisation (characterisation) — work in progress
        • 📊 Visualisation (visualisation) — work in progress
    • Tutorials
      • Tutorial 1 — Solving a Benchmark Function
        • Step 1: Choose a problem
        • Step 2: Pick search operators
        • Step 3: Create and run a metaheuristic
      • Tutorial 2 — Automatic Metaheuristic Design with the Hyper-heuristic
        • Step 1: Prepare the problem (same as above)
        • Step 2: Configure the hyper-heuristic
        • Step 3: Run
      • Tutorial 3 — Batch Experiments
        • Using a JSON configuration file
        • Programmatic configuration
      • Tutorial 4 — Creating Custom Operator Collections
    • Data Structure
      • Top-Level Schema
      • Results Entry
      • Symbol Legend
      • Example: Loading Results
    • Overview

API Reference

  • API Reference
    • Benchmark Functions
      • Ackley1
        • Ackley1.get_func_val()
      • Ackley4
        • Ackley4.get_func_val()
      • Alpine1
        • Alpine1.get_func_val()
      • Alpine2
        • Alpine2.get_func_val()
      • Bohachevsky
        • Bohachevsky.get_func_val()
      • Brent
        • Brent.get_func_val()
      • Brown
        • Brown.get_func_val()
      • CarromTable
        • CarromTable.get_func_val()
      • ChungReynolds
        • ChungReynolds.get_func_val()
      • Cigar
        • Cigar.get_func_val()
      • CosineMixture
        • CosineMixture.get_func_val()
      • CrossInTray
        • CrossInTray.get_func_val()
      • CrossLegTable
        • CrossLegTable.get_func_val()
      • CrownedCross
        • CrownedCross.get_func_val()
      • Csendes
        • Csendes.get_func_val()
      • Deb1
        • Deb1.get_func_val()
      • Deb2
        • Deb2.get_func_val()
      • DeflectedCorrugatedSpring
        • DeflectedCorrugatedSpring.get_func_val()
      • DixonPrice
        • DixonPrice.get_func_val()
      • DropWave
        • DropWave.get_func_val()
      • EggHolder
        • EggHolder.get_func_val()
      • Ellipsoid
        • Ellipsoid.get_func_val()
      • ExpandedDecreasingMinima
        • ExpandedDecreasingMinima.get_func_val()
      • ExpandedEqualMinima
        • ExpandedEqualMinima.get_func_val()
      • ExpandedFiveUnevenPeakTrap
        • ExpandedFiveUnevenPeakTrap.get_func_val()
      • ExpandedTwoPeakTrap
        • ExpandedTwoPeakTrap.get_func_val()
      • ExpandedUnevenMinima
        • ExpandedUnevenMinima.get_func_val()
      • Exponential
        • Exponential.get_func_val()
      • F2
        • F2.l_values
        • F2.get_func_val()
      • Giunta
        • Giunta.get_func_val()
      • Griewank
        • Griewank.get_func_val()
      • HappyCat
        • HappyCat.get_func_val()
      • HyperEllipsoid
        • HyperEllipsoid.get_func_val()
      • InvertedCosineWave
        • InvertedCosineWave.get_func_val()
      • JennrichSampson
        • JennrichSampson.get_func_val()
      • KTablet
        • KTablet.get_func_val()
      • Katsuura
        • Katsuura.get_func_val()
      • Levy
        • Levy.get_func_val()
      • LunacekN01
        • LunacekN01.get_func_val()
      • LunacekN02
        • LunacekN02.get_func_val()
      • Michalewicz
        • Michalewicz.approximated_optima
        • Michalewicz.get_func_val()
      • Mishra1
        • Mishra1.get_func_val()
      • Mishra2
        • Mishra2.get_func_val()
      • Mishra7
        • Mishra7.get_func_val()
      • Mishra11
        • Mishra11.get_func_val()
      • ModifiedVincent
        • ModifiedVincent.get_func_val()
      • NeedleEye
        • NeedleEye.get_func_val()
      • Pathological
        • Pathological.get_func_val()
      • Periodic
        • Periodic.get_func_val()
      • Perm01
        • Perm01.get_func_val()
      • Perm02
        • Perm02.get_func_val()
      • Pinter
        • Pinter.get_func_val()
      • PowellSum
        • PowellSum.get_func_val()
      • Price01
        • Price01.get_func_val()
      • Qing
        • Qing.get_func_val()
      • Quartic
        • Quartic.get_func_val()
      • Quintic
        • Quintic.get_func_val()
      • Rana
        • Rana.get_func_val()
      • Rastrigin
        • Rastrigin.get_func_val()
      • Ridge
        • Ridge.get_func_val()
      • Rosenbrock
        • Rosenbrock.get_func_val()
      • RotatedHyperEllipsoid
        • RotatedHyperEllipsoid.get_func_val()
      • Salomon
        • Salomon.get_func_val()
      • Sargan
        • Sargan.get_func_val()
      • SchafferN1
        • SchafferN1.get_func_val()
      • SchafferN2
        • SchafferN2.get_func_val()
      • SchafferN3
        • SchafferN3.get_func_val()
      • SchafferN4
        • SchafferN4.get_func_val()
      • SchafferN6
        • SchafferN6.get_func_val()
      • Schubert
        • Schubert.get_func_val()
      • Schubert3
        • Schubert3.get_func_val()
      • Schubert4
        • Schubert4.get_func_val()
      • SchumerSteiglitz
        • SchumerSteiglitz.get_func_val()
      • Schwefel
        • Schwefel.get_func_val()
      • Schwefel12
        • Schwefel12.get_func_val()
      • Schwefel204
        • Schwefel204.get_func_val()
      • Schwefel220
        • Schwefel220.get_func_val()
      • Schwefel221
        • Schwefel221.get_func_val()
      • Schwefel222
        • Schwefel222.get_func_val()
      • Schwefel223
        • Schwefel223.get_func_val()
      • Schwefel225
        • Schwefel225.get_func_val()
      • Schwefel226
        • Schwefel226.get_func_val()
      • Sphere
        • Sphere.get_func_val()
      • Step
        • Step.get_func_val()
      • Step2
        • Step2.get_func_val()
      • Step3
        • Step3.get_func_val()
      • StepInt
        • StepInt.get_func_val()
      • Stochastic
        • Stochastic.get_func_val()
      • StrechedVSineWave
        • StrechedVSineWave.get_func_val()
      • StyblinskiTang
        • StyblinskiTang.get_func_val()
      • SumSquares
        • SumSquares.get_func_val()
      • Trid
        • Trid.get_func_val()
      • Trigonometric1
        • Trigonometric1.get_func_val()
      • Trigonometric2
        • Trigonometric2.get_func_val()
      • TypeI
        • TypeI.get_func_val()
      • TypeII
        • TypeII.get_func_val()
      • Vincent
        • Vincent.get_func_val()
      • WWavy
        • WWavy.get_func_val()
      • Weierstrass
        • Weierstrass.get_func_val()
      • Whitley
        • Whitley.get_func_val()
      • XinSheYang1
        • XinSheYang1.get_func_val()
      • XinSheYang2
        • XinSheYang2.get_func_val()
      • XinSheYang3
        • XinSheYang3.get_func_val()
      • XinSheYang4
        • XinSheYang4.get_func_val()
      • YaoLiu09
        • YaoLiu09.get_func_val()
      • Zakharov
        • Zakharov.get_func_val()
      • ZeroSum
        • ZeroSum.get_func_val()
      • CEC2005
        • CEC2005.get_func_val()
        • CEC2005.get_formatted_problem()
    • Population
      • Population
        • Population.iteration
        • Population.metropolis_temperature
        • Population.metropolis_rate
        • Population.metropolis_boltzmann
        • Population.probability_selection
        • Population.__init__()
        • Population.positions
        • Population.get_state()
        • Population.get_positions()
        • Population.set_positions()
        • Population.revert_positions()
        • Population.update_positions()
        • Population.evaluate_fitness()
        • Population.initialise_positions()
        • Population.rescale_back()
    • Search Operators
      • local_random_walk()
      • random_search()
      • random_sample()
      • random_flight()
      • differential_mutation()
      • firefly_dynamic()
      • swarm_dynamic()
      • gravitational_search()
      • central_force_dynamic()
      • spiral_dynamic()
      • genetic_mutation()
      • genetic_crossover()
      • linear_system()
    • Metaheuristic
      • Metaheuristic
        • Metaheuristic.__init__()
        • Metaheuristic.apply_initialiser()
        • Metaheuristic.apply_search_operator()
        • Metaheuristic.run()
        • Metaheuristic.set_finalisation_conditions()
        • Metaheuristic.finaliser()
        • Metaheuristic.get_solution()
        • Metaheuristic.reset_historicals()
        • Metaheuristic.update_historicals()
    • Hyper-heuristic
      • Hyperheuristic
        • Hyperheuristic.__init__()
        • Hyperheuristic.toggle_seq_as_meta()
        • Hyperheuristic.get_operators()
        • Hyperheuristic.solve()
        • Hyperheuristic.evaluate_candidate_solution()
        • Hyperheuristic.brute_force()
        • Hyperheuristic.basic_metaheuristics()
        • Hyperheuristic.get_performance()
        • Hyperheuristic.get_statistics()
      • HyperheuristicError
    • Experiment
      • Experiment
        • Experiment.__init__()
        • Experiment.run()
      • ExperimentError
      • read_config_file()
      • create_task_list()
    • Tools
      • printmsk()
      • listfind()
      • revise_results()
      • read_folder_files()
      • preprocess_files()
      • df2dict()
      • check_fields()
      • save_json()
      • read_json()
      • merge_json()
      • NumpyEncoder
        • NumpyEncoder.default()
    • Machine Learning
      • obtain_sample_weight()
      • DatasetSequences
        • DatasetSequences.__init__()
        • DatasetSequences.apply_one_hot_encoding()
        • DatasetSequences.obtain_dataset()
      • retrieve_model_info()
      • Encoder
        • Encoder.encode()
      • ModelPredictorKeras
        • ModelPredictorKeras.fit()
        • ModelPredictorKeras.predict()
        • ModelPredictorKeras.load()
        • ModelPredictorKeras.save()
      • ModelPredictor()
    • Characterisation
      • Characteriser
        • Characteriser.initialise()
        • Characteriser.length_scale()
      • CharacteriserError
    • Visualisation
      • show_performance_overview()

Project

  • References
    • Seminal Papers
    • Journal Papers Using CUSTOMHyS
    • Conference Papers Using CUSTOMHyS
    • How to Cite
  • Contributing to customhys
    • Development Setup
    • Development Workflow
      • Code Quality
      • Pre-commit Hooks
      • Testing
    • Making Changes
    • Coding Standards
      • Python Style
      • Documentation
      • Commit Messages
    • Project Structure
    • Optional Dependencies
    • Reporting Issues
    • Questions?
    • License
  • Changelog
    • [1.1.8] - 2026-02-03
      • Changed
      • Added
        • Development Tooling
        • Testing Infrastructure (136 tests total)
        • Documentation
        • Build System
      • Fixed
        • Security Vulnerabilities
        • Code Issues
        • Test Issues
        • Project Structure
      • Security
      • Performance
      • Testing
    • [1.1.7] - Previous Release
    • Migration Guide: 1.1.7 → 1.1.8
      • For End Users
        • Standard Installation
        • If Using Jupyter/Notebooks
        • If Developing
      • For Contributors
        • Quick Setup
        • What Changed for Development
      • Breaking Changes
      • Non-Breaking Improvements
    • Impact Summary: Version 1.1.8
      • Quantitative Improvements
      • Qualitative Improvements
        • Developer Experience
        • Security
        • Maintainability
        • Performance
      • Core Installation (minimal dependencies)
      • With Machine Learning Support
      • Development Installation
      • Migration from 1.1.7 to 1.1.8
    • Version 1.1.8 Summary
      • What’s New in This Release
      • Issues Resolved
      • Recommended Actions After Upgrade
CUSTOMHyS
  • Python Module Index

Python Module Index

c
 
c
- customhys
    customhys.benchmark_func
    customhys.characterisation
    customhys.experiment
    customhys.hyperheuristic
    customhys.machine_learning
    customhys.metaheuristic
    customhys.operators
    customhys.population
    customhys.tools
    customhys.visualisation

© Copyright 2025, Jorge Mario Cruz-Duarte.

Built with Sphinx using a theme provided by Read the Docs.