rtac

Welcome to rtac’s documentation! Please check out how to install it using the Installation guide. For information about how to use it and what general functions there are look at the Usage section.

Contents

• Description
  • RTAC: A Realtime Algorithm Configuration Methods Suite
  • RAC
  • ReACTR
  • ReACTR++
  • CPPL
  • Gray-Box RAC
  • References
• Installation Guide
  • Requirements
  • Installation
• Usage
  • Necessary Provisions
  • Hyperparameters
  • What To Use
• Examples
  • Example Target Algorithm Wrapper
  • Scenario File Examples
    • ReACTR
    • ReACTR++
    • CPPL
    • Gray-Box
  • Parameter Files
    • PCS
    • JSON
      • Required Field
      • Fields by Type
      • Optional Common Fields
      • Log Distribution Options (if used)
      • Example
  • Example RTAC call
• API Reference
  • rtac
    • rtac.ac_functionalities
      • rtac.ac_functionalities.config_gens
        • AbstractConfigGen
        • DefaultConfigGen
        • RandomConfigGen
      • rtac.ac_functionalities.logs
        • AbstractLogs
        • NewRotatingFileHandler
        • RTACLogs
      • rtac.ac_functionalities.ranking
        • rtac.ac_functionalities.ranking.cppl
        • rtac.ac_functionalities.ranking.gray_box
        • rtac.ac_functionalities.ranking.trueskill
      • rtac.ac_functionalities.result_processing
        • AbstractResultProcessing
        • Contender
        • ResultProcessing
        • ResultProcessingCPPL
        • ResultProcessingpp
        • processing_factory()
      • rtac.ac_functionalities.rtac_data
        • ACMethod
        • AbstractRTACData
        • BinaryParameter
        • CategoricalParameter
        • Configuration
        • ContinuousParameter
        • DiscreteParameter
        • Distribution
        • GBData
        • Generator
        • InterimMeaning
        • ParamType
        • Parameter
        • RTACData
        • RTACDatapp
        • TARun
        • TARunStatus
        • TournamentStats
        • ValType
        • rtacdata_factory()
      • rtac.ac_functionalities.ta_runner
        • AbstractTARunner
        • BaseTARunner
        • TARunnerpp
        • gb_record()
        • non_block_read()
        • ta_runner_factory()
      • rtac.ac_functionalities.tournament
        • AbstractTournament
        • Tournament
        • Tournament_GB
        • Tournamentpp
        • tournament_factory()
      • rtac.ac_functionalities.tournament_manager
        • AbstractTournamentManager
        • GrayBox
        • TournamentManager
        • TournamentManagerCPPL
        • tourn_manager_factory()
    • rtac.examples
      • rtac.examples.main
        • main()
        • run_example()
    • rtac.feature_gen
      • rtac.feature_gen.tsp_feats
        • TSPFeats
    • rtac.rtac
      • AbstractRTAC
        • AbstractRTAC.init_rtac_data()
        • AbstractRTAC.init_tournament_manager()
        • AbstractRTAC.solve_instance()
      • RTAC
        • RTAC.black_box()
        • RTAC.gray_box()
        • RTAC.plot_performances()
        • RTAC.provide_early_instance()
        • RTAC.result_output()
        • RTAC.solve_instance()
        • RTAC.wrap_up_gb()
      • RTACpp
        • RTACpp.init_rtac_data()
        • RTACpp.init_tournament_manager()
      • rtac_factory()
    • rtac.utils
      • rtac.utils.background_thread_control
        • set_background_thread_nr()
      • rtac.utils.clean_logs
        • is_file_open()
        • remove_fuse_hidden_files()
      • rtac.utils.ensure_package
        • ensure_package()
      • rtac.utils.json_validation
        • validateparams()
      • rtac.utils.process_affinity
        • set_affinity_recursive()
      • rtac.utils.read_io
        • read_args()
        • translate_params()
    • rtac.wrapper
      • rtac.wrapper.abstract_wrapper
        • AbstractWrapper
      • rtac.wrapper.tsp
        • TSP_Q
        • TSP_Qpp
        • TSP_RT
        • TSP_RTpp