Class TrainingParameters


  • public class TrainingParameters
    extends java.lang.Object
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String algorithm()
      Retrieves the training algorithm name.
      java.lang.String algorithm​(java.lang.String namespace)
      Retrieves the training algorithm name for a given name space.
      static TrainingParameters defaultParams()  
      boolean getBooleanParameter​(java.lang.String key, boolean defaultValue)
      get a Boolean parameter
      boolean getBooleanParameter​(java.lang.String namespace, java.lang.String key, boolean defaultValue)
      get a Boolean parameter in the specified namespace
      double getDoubleParameter​(java.lang.String key, double defaultValue)
      get a Double parameter
      double getDoubleParameter​(java.lang.String namespace, java.lang.String key, double defaultValue)
      get a Double parameter in the specified namespace
      int getIntParameter​(java.lang.String key, int defaultValue)
      get an Integer parameter
      int getIntParameter​(java.lang.String namespace, java.lang.String key, int defaultValue)
      get an Integer parameter in the specified namespace
      java.util.Map<java.lang.String,​java.lang.Object> getObjectSettings()
      Retrieves all parameters without a name space.
      java.util.Map<java.lang.String,​java.lang.Object> getObjectSettings​(java.lang.String namespace)
      Retrieves a map with the training parameters which have the passed name space.
      TrainingParameters getParameters​(java.lang.String namespace)  
      java.util.Map<java.lang.String,​java.lang.String> getSettings()
      Deprecated.
      java.util.Map<java.lang.String,​java.lang.String> getSettings​(java.lang.String namespace)
      Deprecated.
      java.lang.String getStringParameter​(java.lang.String key, java.lang.String defaultValue)
      get a String parameter.
      java.lang.String getStringParameter​(java.lang.String namespace, java.lang.String key, java.lang.String defaultValue)
      get a String parameter in the specified namespace.
      void put​(java.lang.String key, boolean value)  
      void put​(java.lang.String key, double value)  
      void put​(java.lang.String key, int value)  
      void put​(java.lang.String key, java.lang.String value)  
      void put​(java.lang.String namespace, java.lang.String key, boolean value)  
      void put​(java.lang.String namespace, java.lang.String key, double value)  
      void put​(java.lang.String namespace, java.lang.String key, int value)  
      void put​(java.lang.String namespace, java.lang.String key, java.lang.String value)  
      void putIfAbsent​(java.lang.String key, boolean value)  
      void putIfAbsent​(java.lang.String key, double value)  
      void putIfAbsent​(java.lang.String key, int value)  
      void putIfAbsent​(java.lang.String key, java.lang.String value)  
      void putIfAbsent​(java.lang.String namespace, java.lang.String key, boolean value)  
      void putIfAbsent​(java.lang.String namespace, java.lang.String key, double value)  
      void putIfAbsent​(java.lang.String namespace, java.lang.String key, int value)  
      void putIfAbsent​(java.lang.String namespace, java.lang.String key, java.lang.String value)  
      void serialize​(java.io.OutputStream out)  
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • TrainingParameters

        public TrainingParameters()
      • TrainingParameters

        public TrainingParameters​(TrainingParameters trainingParameters)
      • TrainingParameters

        public TrainingParameters​(java.util.Map<java.lang.String,​java.lang.String> map)
        Deprecated.
      • TrainingParameters

        public TrainingParameters​(java.io.InputStream in)
                           throws java.io.IOException
        Throws:
        java.io.IOException
    • Method Detail

      • algorithm

        public java.lang.String algorithm​(java.lang.String namespace)
        Retrieves the training algorithm name for a given name space.
        Returns:
        the name or null if not set.
      • algorithm

        public java.lang.String algorithm()
        Retrieves the training algorithm name.
        Returns:
        the name or null if not set.
      • getSettings

        public java.util.Map<java.lang.String,​java.lang.String> getSettings​(java.lang.String namespace)
        Deprecated.
        Retrieves a map with the training parameters which have the passed name space.
        Parameters:
        namespace -
        Returns:
        a parameter map which can be passed to the train and validate methods.
      • getSettings

        public java.util.Map<java.lang.String,​java.lang.String> getSettings()
        Deprecated.
        Retrieves all parameters without a name space.
        Returns:
        the settings map
      • getObjectSettings

        public java.util.Map<java.lang.String,​java.lang.Object> getObjectSettings​(java.lang.String namespace)
        Retrieves a map with the training parameters which have the passed name space.
        Parameters:
        namespace -
        Returns:
        a parameter map which can be passed to the train and validate methods.
      • getObjectSettings

        public java.util.Map<java.lang.String,​java.lang.Object> getObjectSettings()
        Retrieves all parameters without a name space.
        Returns:
        the settings map
      • putIfAbsent

        public void putIfAbsent​(java.lang.String namespace,
                                java.lang.String key,
                                java.lang.String value)
      • putIfAbsent

        public void putIfAbsent​(java.lang.String key,
                                java.lang.String value)
      • putIfAbsent

        public void putIfAbsent​(java.lang.String namespace,
                                java.lang.String key,
                                int value)
      • putIfAbsent

        public void putIfAbsent​(java.lang.String key,
                                int value)
      • putIfAbsent

        public void putIfAbsent​(java.lang.String namespace,
                                java.lang.String key,
                                double value)
      • putIfAbsent

        public void putIfAbsent​(java.lang.String key,
                                double value)
      • putIfAbsent

        public void putIfAbsent​(java.lang.String namespace,
                                java.lang.String key,
                                boolean value)
      • putIfAbsent

        public void putIfAbsent​(java.lang.String key,
                                boolean value)
      • put

        public void put​(java.lang.String namespace,
                        java.lang.String key,
                        java.lang.String value)
      • put

        public void put​(java.lang.String key,
                        java.lang.String value)
      • put

        public void put​(java.lang.String namespace,
                        java.lang.String key,
                        int value)
      • put

        public void put​(java.lang.String key,
                        int value)
      • put

        public void put​(java.lang.String namespace,
                        java.lang.String key,
                        double value)
      • put

        public void put​(java.lang.String key,
                        double value)
      • put

        public void put​(java.lang.String namespace,
                        java.lang.String key,
                        boolean value)
      • put

        public void put​(java.lang.String key,
                        boolean value)
      • serialize

        public void serialize​(java.io.OutputStream out)
                       throws java.io.IOException
        Throws:
        java.io.IOException
      • getStringParameter

        public java.lang.String getStringParameter​(java.lang.String key,
                                                   java.lang.String defaultValue)
        get a String parameter. ClassCastException can be thrown if the value is not String
        Parameters:
        key -
        defaultValue -
        Returns:
      • getStringParameter

        public java.lang.String getStringParameter​(java.lang.String namespace,
                                                   java.lang.String key,
                                                   java.lang.String defaultValue)
        get a String parameter in the specified namespace. ClassCastException can be thrown if the value is not String
        Parameters:
        namespace -
        key -
        defaultValue -
        Returns:
      • getIntParameter

        public int getIntParameter​(java.lang.String key,
                                   int defaultValue)
        get an Integer parameter
        Parameters:
        key -
        defaultValue -
        Returns:
      • getIntParameter

        public int getIntParameter​(java.lang.String namespace,
                                   java.lang.String key,
                                   int defaultValue)
        get an Integer parameter in the specified namespace
        Parameters:
        namespace -
        key -
        defaultValue -
        Returns:
      • getDoubleParameter

        public double getDoubleParameter​(java.lang.String key,
                                         double defaultValue)
        get a Double parameter
        Parameters:
        key -
        defaultValue -
        Returns:
      • getDoubleParameter

        public double getDoubleParameter​(java.lang.String namespace,
                                         java.lang.String key,
                                         double defaultValue)
        get a Double parameter in the specified namespace
        Parameters:
        namespace -
        key -
        defaultValue -
        Returns:
      • getBooleanParameter

        public boolean getBooleanParameter​(java.lang.String key,
                                           boolean defaultValue)
        get a Boolean parameter
        Parameters:
        key -
        defaultValue -
        Returns:
      • getBooleanParameter

        public boolean getBooleanParameter​(java.lang.String namespace,
                                           java.lang.String key,
                                           boolean defaultValue)
        get a Boolean parameter in the specified namespace
        Parameters:
        namespace -
        key -
        defaultValue -
        Returns: