mlpack_main.hpp

Go to the documentation of this file.

#ifndef MLPACK_BINDINGS_PYTHON_MLPACK_MAIN_HPP
#define MLPACK_BINDINGS_PYTHON_MLPACK_MAIN_HPP

#ifndef BINDING_TYPE
  #error "BINDING_TYPE not defined!  Don't include this file directly!"
#endif
#if BINDING_TYPE != BINDING_TYPE_PYX
  #error "BINDING_TYPE is not set to BINDING_TYPE_PYX!"
#endif

// Matrices are transposed on load/save.
#define BINDING_MATRIX_TRANSPOSED true

#include <mlpack/bindings/python/py_option.hpp>
#include <mlpack/bindings/python/print_doc_functions.hpp>

#define PRINT_PARAM_STRING mlpack::bindings::python::ParamString

#define PRINT_PARAM_VALUE mlpack::bindings::python::PrintValue

#define PRINT_DATASET mlpack::bindings::python::PrintDataset

#define PRINT_MODEL mlpack::bindings::python::PrintModel

#define IMPORT_EXT_LIB mlpack::bindings::python::ImportExtLib

#define IMPORT_SPLIT mlpack::bindings::python::ImportSplit

#define IMPORT_THIS mlpack::bindings::python::ImportThis

#define GET_DATASET mlpack::bindings::python::GetDataset

#define SPLIT_TRAIN_TEST mlpack::bindings::python::SplitTrainTest

#define CREATE_OBJECT(...) mlpack::bindings::python::CreateObject(\
    STRINGIFY(BINDING_NAME), __VA_ARGS__)

#define CALL_METHOD(...) mlpack::bindings::python::CallMethod(\
    STRINGIFY(BINDING_NAME), __VA_ARGS__)

#define PRINT_CALL mlpack::bindings::python::ProgramCall

#define BINDING_IGNORE_CHECK(x) mlpack::bindings::python::IgnoreCheck( \
    STRINGIFY(BINDING_NAME), x)

namespace mlpack {
namespace util {

template<typename T>
using Option = mlpack::bindings::python::PyOption<T>;

}
}

#include <mlpack/core/util/param.hpp>

// In Python, we want to call the binding function mlpack_<BINDING_NAME>()
// instead of just <BINDING_NAME>(), so we change the definition of
// BINDING_FUNCTION().
#undef BINDING_FUNCTION
#define BINDING_FUNCTION(...) JOIN(mlpack_, BINDING_NAME)(__VA_ARGS__)

// Define parameters available in every Python binding.
PARAM_GLOBAL(bool, "verbose", "Display informational messages and the full "
    "list of parameters and timers at the end of execution.", "v", "bool",
    false, true, false, false);
PARAM_GLOBAL(bool, "copy_all_inputs", "If specified, all input parameters "
    "will be deep copied before the method is run.  This is useful for "
    "debugging problems where the input parameters are being modified "
    "by the algorithm, but can slow down the code.", "", "bool",
    false, true, false, false);
PARAM_GLOBAL(bool, "check_input_matrices", "If specified, the input matrix "
    "is checked for NaN and inf values; an exception is thrown if any are "
    "found.", "", "bool", false, true, false, false);

#endif