print_doc_functions.hpp

Go to the documentation of this file.

#ifndef MLPACK_BINDINGS_PYTHON_PRINT_DOC_FUNCTIONS_HPP
#define MLPACK_BINDINGS_PYTHON_PRINT_DOC_FUNCTIONS_HPP

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

namespace mlpack {
namespace bindings {
namespace python {

inline std::string GetBindingName(const std::string& bindingName);

inline std::string PrintImport(const std::string& bindingName);

inline std::string PrintInputOptionInfo();

inline std::string PrintOutputOptionInfo();

template<typename T>
inline std::string PrintValue(const T& value, bool quotes);

// Special overload for booleans.
template<>
inline std::string PrintValue(const bool& value, bool quotes);

inline std::string PrintDefault(const std::string& bindingName,
                                const std::string& paramName);

// Recursion base case.
inline std::string PrintInputOptions(util::Params& params,
                                     bool onlyHyperParams,
                                     bool onlyMatrixParams);

template<typename T, typename... Args>
std::string PrintInputOptions(util::Params& params,
                              bool onlyHyperParams,
                              bool onlyMatrixParams,
                              const std::string& paramName,
                              const T& value,
                              Args... args);

// Recursion base case.
inline std::string PrintOutputOptions(util::Params& params);

template<typename T, typename... Args>
std::string PrintOutputOptions(util::Params& params,
                               const std::string& paramName,
                               const T& value,
                               Args... args);

template<typename... Args>
std::string ProgramCall(const std::string& programName, Args... args);

inline std::string ProgramCall(util::Params& p, const std::string& programName);

inline std::string PrintModel(const std::string& modelName);

inline std::string PrintDataset(const std::string& datasetName);

inline std::string ParamString(const std::string& paramName);

inline std::string ImportExtLib();

inline std::string ImportSplit();

inline std::string ImportThis(const std::string& groupName);

inline std::string SplitTrainTest(const std::string& datasetName,
                                  const std::string& labelName,
                                  const std::string& trainDataset,
                                  const std::string& trainLabels,
                                  const std::string& testDataset,
                                  const std::string& testLabels,
                                  const std::string& splitRatio);

inline std::string GetDataset(const std::string& datasetName,
                              const std::string& url);

template<typename... Args>
std::string CreateObject(const std::string& bindingName,
                         const std::string& objectName,
                         const std::string& groupName,
                         Args... args);

inline std::string CreateObject(const std::string& bindingName,
                                const std::string& objectName,
                                const std::string& groupName);

template<typename... Args>
std::string CallMethod(const std::string& bindingName,
                       const std::string& objectName,
                       const std::string& methodName,
                       Args... args);

inline bool IgnoreCheck(const std::string& bindingName,
                          const std::string& paramName);

inline bool IgnoreCheck(const std::string& bindingName,
                          const std::vector<std::string>& constraints);

inline bool IgnoreCheck(
    const std::string& bindingName,
    const std::vector<std::pair<std::string, bool>>& constraints,
    const std::string& paramName);

} // namespace python
} // namespace bindings
} // namespace mlpack

// Include implementation.
#include "print_doc_functions_impl.hpp"

#endif