Package ai.libs.jaicore.ml.hpo.multifidelity.hyperband

Interface IHyperbandConfig

  • All Superinterfaces:
    org.aeonbits.owner.Accessible, org.aeonbits.owner.Config, org.api4.java.algorithm.IAlgorithmConfig, org.api4.java.common.control.IConfig, ai.libs.jaicore.basic.IOwnerBasedAlgorithmConfig, ai.libs.jaicore.basic.IOwnerBasedConfig, java.util.Map<java.lang.Object,​java.lang.Object>, org.aeonbits.owner.Mutable, org.aeonbits.owner.Reloadable, java.io.Serializable
    public interface IHyperbandConfig
extends ai.libs.jaicore.basic.IOwnerBasedAlgorithmConfig

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.aeonbits.owner.Config

        org.aeonbits.owner.Config.ConverterClass, org.aeonbits.owner.Config.DecryptorClass, org.aeonbits.owner.Config.DefaultValue, org.aeonbits.owner.Config.DisableableFeature, org.aeonbits.owner.Config.DisableFeature, org.aeonbits.owner.Config.EncryptedValue, org.aeonbits.owner.Config.HotReload, org.aeonbits.owner.Config.HotReloadType, org.aeonbits.owner.Config.Key, org.aeonbits.owner.Config.LoadPolicy, org.aeonbits.owner.Config.LoadType, org.aeonbits.owner.Config.PreprocessorClasses, org.aeonbits.owner.Config.Separator, org.aeonbits.owner.Config.Sources, org.aeonbits.owner.Config.TokenizerClass

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String K_CRASH_SCORE  
      static java.lang.String K_ETA  
      static java.lang.String K_ITERATIONS  
      static java.lang.String K_SEED  
      static java.lang.String NS  

      • Fields inherited from interface ai.libs.jaicore.basic.IOwnerBasedAlgorithmConfig

        K_CPUS, K_MEMORY, K_THREADS, K_TIMEOUT

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      double getCrashScore()  
      double getEta()
      The parameter eta defines that after each round eta^-1 many solutions of the current population are preserved for the next stage of a race.
      java.lang.String getIterations()
      The number of iterations can either be defined by 'auto' to be calculated as proposed in the paper or by defining a custom positive integer.
      long getSeed()  

      • Methods inherited from interface org.aeonbits.owner.Accessible

        fill, getProperty, getProperty, list, list, propertyNames, store, storeToXML

      • Methods inherited from interface org.api4.java.common.control.IConfig

        setProperty

      • Methods inherited from interface ai.libs.jaicore.basic.IOwnerBasedAlgorithmConfig

        cpus, getTimeout, memory, threads, timeout

      • Methods inherited from interface ai.libs.jaicore.basic.IOwnerBasedConfig

        copy, loadPropertiesFromFile, loadPropertiesFromFileArray, loadPropertiesFromList, loadPropertiesFromResource

      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

      • Methods inherited from interface org.aeonbits.owner.Mutable

        addPropertyChangeListener, addPropertyChangeListener, clear, load, load, removeProperty, removePropertyChangeListener, setProperty

      • Methods inherited from interface org.aeonbits.owner.Reloadable

        addReloadListener, reload, removeReloadListener

    • Method Detail

      • getEta

        @Key("hpo.hyperband.eta")
@DefaultValue("3")
double getEta()
        The parameter eta defines that after each round eta^-1 many solutions of the current population are preserved for the next stage of a race. The default value (according to the Hyperband paper) is 3.
        Returns:
        The value of the parameter eta.

      • getSeed

        @Key("hpo.hyperband.seed")
@DefaultValue("42")
long getSeed()
        Returns:
        The seed for the pseudo random number generator.

      • getIterations

        @Key("hpo.hyperband.iterations")
@DefaultValue("auto")
java.lang.String getIterations()
        The number of iterations can either be defined by 'auto' to be calculated as proposed in the paper or by defining a custom positive integer. Caution: The number of candidates in the first round is exponential in the number of iterations.
        Returns:
        The number of iterations.

      • getCrashScore

        @Key("hpo.hyperband.crash_score")
@DefaultValue("2147483647")
double getCrashScore()
        Returns:
        The score to be assigned to crashed evaluations.