mlpack  3.0.2
mlpack::hpt Namespace Reference

Classes

class  CVFunction
 This wrapper serves for adapting the interface of the cross-validation classes to the one that can be utilized by the mlpack optimizers. More...

 
struct  DeduceHyperParameterTypes
 A type function for deducing types of hyper-parameters from types of arguments in the Optimize method in HyperParameterTuner. More...

 
struct  DeduceHyperParameterTypes< PreFixedArg< T >, Args... >
 Defining DeduceHyperParameterTypes for the case when not all argument types have been processed, and the next one is the type of an argument that should be fixed. More...

 
struct  DeduceHyperParameterTypes< T, Args... >
 Defining DeduceHyperParameterTypes for the case when not all argument types have been processed, and the next one (T) is a collection type or an arithmetic type. More...

 
struct  FixedArg
 A struct for storing information about a fixed argument. More...

 
class  HyperParameterTuner
 The class HyperParameterTuner for the given MLAlgorithm utilizes the provided Optimizer to find the values of hyper-parameters that optimize the value of the given Metric. More...

 
class  IsPreFixedArg
 A type function for checking whether the given type is PreFixedArg. More...

 
struct  PreFixedArg
 A struct for marking arguments as ones that should be fixed (it can be useful for the Optimize method of HyperParameterTuner). More...

 
struct  PreFixedArg< T & >
 The specialization of the template for references. More...

 

Typedefs

template<typename... Args>
using TupleOfHyperParameters = typename DeduceHyperParameterTypes< Args... >::TupleType
 A short alias for deducing types of hyper-parameters from types of arguments in the Optimize method in HyperParameterTuner. More...

 

Functions

template
<
typename
T
>
PreFixedArg< T > Fixed (T &&value)
 Mark the given argument as one that should be fixed. More...

 

Typedef Documentation

◆ TupleOfHyperParameters

using TupleOfHyperParameters = typename DeduceHyperParameterTypes<Args...>::TupleType

A short alias for deducing types of hyper-parameters from types of arguments in the Optimize method in HyperParameterTuner.

Definition at line 127 of file deduce_hp_types.hpp.

Function Documentation

◆ Fixed()

PreFixedArg<T> mlpack::hpt::Fixed ( T &&  value)

Mark the given argument as one that should be fixed.

It can be applied to arguments that are passed to the Optimize method of HyperParameterTuner.

The implementation avoids data copying. If the passed argument is an l-value reference, we store it as a const l-value rerefence inside the returned PreFixedArg object. If the passed argument is an r-value reference, light-weight copying (by taking possession of the r-value) will be made during the initialization of the returned PreFixedArg object.

Definition at line 36 of file fixed.hpp.