print_param_table.hpp File Reference

Include dependency graph for print_param_table.hpp:

Go to the source code of this file.

Functions
void	PrintParamTable (const std::string &bindingName, const std::string &language, mlpack::util::Params &params, const std::set< std::string > &headers, std::unordered_set< std::string > &paramsSet, const bool onlyHyperParams, const bool onlyMatrixParams, const bool onlyInputParams, const bool onlyOutputParams)
	Print a table in markdown format that contains a list of parameters. More...

Detailed Description

Author

Nippun Sharma

Prints a table with the parameters of a binding based on certain conditions.

mlpack is free software; you may redistribute it and/or modify it under the terms of the 3-clause BSD license. You should have received a copy of the 3-clause BSD license along with mlpack. If not, see http://www.opensource.org/licenses/BSD-3-Clause for more information.

Definition in file print_param_table.hpp.

Function Documentation

PrintParamTable()

void PrintParamTable	(	const std::string &	bindingName,
		const std::string &	language,
		mlpack::util::Params &	params,
		const std::set< std::string > &	headers,
		std::unordered_set< std::string > &	paramsSet,
		const bool	onlyHyperParams,
		const bool	onlyMatrixParams,
		const bool	onlyInputParams,
		const bool	onlyOutputParams
	)

Print a table in markdown format that contains a list of parameters.

Parameters

bindingName	parameters corresponding to bindingName.
language	parameters for a particular language.
params	Params object.
headers	which headers to print (eg: Name, Default, etc.).
paramsSet	to prevent printing a parameter more than once.
onlyHyperParams	print only hyper-parameters.
onlyMatrixParams	print only matrix-parameters.
onlyInputParams	print only input-parameters.
onlyOutputParams	print only output-parameters.