Data Structures
class	BadOption
	simple exception class for invalid options More...

class	CommandLine
	this class describes a common command line interface More...

class	IOption
	interface for Option class More...

class	Option
	this class describes command line option More...

class	OptionType
	a class models option type More...

class	OptionType< T, false >

class	OptionType< T, true >

Functions
std::vector< std::string >	optname (const char *names)
	convert option names for Option constructor

std::string	overview (const char *descr)
	convert option overview for Option constructor

bool	optional (bool is_optional)
	convert option overview for Option constructor

std::vector< std::string >	optvalues (const char *vals)
	register valid values for option

std::vector< char >	separators (const char *seps)
	separators that separate option name and its value

bool	showopt (bool is_shown)

void	checkInFile (const Option< std::string > &in_file)

void	checkOutFile (const Option< std::string > &out_file)

void	checkInDir (const Option< std::string > &dir)

void	checkOutDir (const Option< std::string > &dir)

Variables
Option< bool >	Help (optname("--help, -h"), overview("print usage and exit"), false, optional(true))

Option< bool >	caffeFrontend (optname("--caffe"), overview("treat input file as Caffe model"), false, optional(true), optvalues(""), nullptr, separators(""), showopt(false))

Option< bool >	onnxFrontend (optname("--onnx"), overview("treat input file as ONNX model"), false, optional(true), optvalues(""), nullptr, separators(""), showopt(false))

Option< bool >	caffe2Frontend (optname("--caffe2"), overview("treat input file as Caffe2 model (predict_net.pb)"), false, optional(false), optvalues(""), nullptr, separators(""), showopt(false), IOption::Group::caffe2)

Option< std::vector< int > >	inputShapes (optname("--input-shape"), overview("Shape of caffe2 input"), std::vector< int >{}, optional(false), optvalues(""), nullptr, separators(""), showopt(false), IOption::Group::caffe2)

Option< std::string >	initNet (optname("--init-net"), overview("path to Caffe2 model weights (init_net.pb)"), std::string(), optional(false), optvalues(""), checkInFile, separators(""), showopt(false), IOption::Group::caffe2)

Option< bool >	tflFrontend (optname("--tflite"), overview("treat input file as Tensor Flow Lite model"), false, optional(true), optvalues(""), nullptr, separators(""), showopt(false))

Option< std::string >	target (optname("--target"), overview("select target language to emit for given architecture." "Valid values are '" NNC_TARGET_ARM_CPP "', '" NNC_TARGET_X86_CPP "', '" NNC_TARGET_ARM_GPU_CPP "', '" NNC_TARGET_INTERPRETER "'"), std::string(), optional(false), optvalues(NNC_TARGET_ARM_CPP "," NNC_TARGET_X86_CPP "," NNC_TARGET_ARM_GPU_CPP "," NNC_TARGET_INTERPRETER), nullptr, separators("="))

Option< std::string >	inputFile (optname("--nnmodel, -m"), overview("specify input file with serialized NN models"), std::string(), optional(false), optvalues(""), checkInFile)

Option< bool >	doOptimizationPass (optname("-O"), overview("whether to optimize model or not"), false, optional(true), optvalues(""), nullptr, separators(""), showopt(true))

Option< bool >	dumpGraph (optname("--dump, -D"), overview("dump graph to dot files after optimization passes"), false, optional(true), optvalues(""), nullptr, separators(""), showopt(true))

Option< std::string >	artifactName (optname("--output, -o"), overview("specify name for output files"), "nnmodel", optional(true), optvalues(""), checkOutFile)

Option< std::string >	artifactDir (optname("--output-dir, -d"), overview("specify directory for output files"), ".", optional(true), optvalues(""), checkOutDir, separators("="))

Option< std::string >	interInputDataDir (optname("--input-data-dir"), overview("specify directory with binary files " "containing the input data for the model " "(one file for each input with the same name)"), ".", optional(true), optvalues(""), checkInDir)

Function Documentation

◆ checkInDir()

void nnc::cli::checkInDir ( const Option< std::string > & dir )

Definition at line 47 of file CLOptionChecker.cpp.

{
  auto stream = opendir(dir.c_str());
 
  if (stream == nullptr)
    throw BadOption(std::string("Could not open directory: ") + std::strerror(errno) + ".");
 
  closedir(stream);
} // checkInDir

◆ checkInFile()

void nnc::cli::checkInFile ( const Option< std::string > & in_file )

Definition at line 27 of file CLOptionChecker.cpp.

{
  if (in_file.empty())
    throw BadOption("Input file name should not be empty");
 
  auto f = fopen(in_file.c_str(), "rb");
  if (!f)
    throw BadOption("Cannot open file <" + in_file + ">");
  fclose(f);
} // checkInFile

◆ checkOutDir()

void nnc::cli::checkOutDir ( const Option< std::string > & dir )

Definition at line 57 of file CLOptionChecker.cpp.

{
  auto stream = opendir(dir.c_str());
 
  if (stream == nullptr)
  {
    // Do not consider the missing directory an error.
    if (errno == ENOENT)
      return;
 
    throw BadOption(std::string("Could not open directory: ") + std::strerror(errno) + ".");
  }
 
  closedir(stream);
} // checkOutDir

◆ checkOutFile()

void nnc::cli::checkOutFile ( const Option< std::string > & out_file )

Definition at line 38 of file CLOptionChecker.cpp.

{
  if (out_file.empty())
    throw BadOption("Output file name should not be empty");
 
 
} // checkOutFile

◆ optional()

bool nnc::cli::optional ( bool is_optional )

inline

convert option overview for Option constructor

Definition at line 413 of file CommandLine.h.

413{ return is_optional; }

◆ optname()

std::vector< std::string > nnc::cli::optname ( const char * names )

convert option names for Option constructor

Parameters

names - name of option, if option has several names then names must be represented by a string separated by a comma

Definition at line 71 of file CommandLine.cpp.

71{ return splitByComma(names); }

Referenced by nnc::cli::CommandLine::parseCommandLine().

◆ optvalues()

std::vector< std::string > nnc::cli::optvalues ( const char * vals )

register valid values for option

Parameters

vals	- valid values of option, if option has several that values then `vals` must be represented by a string separated by a comma

Definition at line 73 of file CommandLine.cpp.

73{ return splitByComma(vals); }

◆ overview()

std::string nnc::cli::overview ( const char * descr )

inline

convert option overview for Option constructor

Definition at line 404 of file CommandLine.h.

{
  std::string overview(descr);
  assert(!overview.empty());
 
  return overview;
}

References overview().

Referenced by overview().

◆ separators()

std::vector< char > nnc::cli::separators ( const char * seps )

separators that separate option name and its value

Parameters

seps	- chars of separators separated by a comma

Definition at line 75 of file CommandLine.cpp.

{
  std::vector<char> ret;
  int i;
 
  if (std::string(seps).empty())
    return ret;
 
  for (i = 0; isspace(seps[i]); i++)
    ;
 
  if (seps[i])
  {
    ret.push_back(seps[i]);
    i++;
  }
 
  for (; seps[i] != '\0'; i++)
  {
    if (seps[i] == ',')
    {
      for (i++; isspace(seps[i]); i++)
        ;
 
      ret.push_back(seps[i]);
    }
  }
 
  return ret;
}

◆ showopt()

bool nnc::cli::showopt ( bool is_shown )

inline

Parameters

is_shown - if set to false, then option won't be shown in help message

Definition at line 431 of file CommandLine.h.

431{ return is_shown; }

Variable Documentation

◆ artifactDir

Option< std::string > nnc::cli::artifactDir	(	optname("--output-dir, -d")	,
		overview("specify directory for output files")	,
		"."	,
		optional(true)	,
		optvalues("")	,
		checkOutDir	,
		separators("=")
	)

Options for backend

Definition at line 57 of file Options.h.

◆ artifactName

Option< std::string > nnc::cli::artifactName	(	optname("--output, -o")	,
		overview("specify name for output files")	,
		"nnmodel"	,
		optional(true)	,
		optvalues("")	,
		checkOutFile
	)

Options for backend

Definition at line 58 of file Options.h.

◆ caffe2Frontend

Option< bool > nnc::cli::caffe2Frontend	(	optname("--caffe2")	,
		overview("treat input file as Caffe2 model (predict_net.pb)")	,
		false	,
		optional(false)	,
		optvalues("")	,
		nullptr	,
		separators("")	,
		showopt(false)	,
		IOption::Group::caffe2
	)

Options for compiler driver

Definition at line 31 of file Options.h.

◆ caffeFrontend

Option< bool > nnc::cli::caffeFrontend	(	optname("--caffe")	,
		overview("treat input file as Caffe model")	,
		false	,
		optional(true)	,
		optvalues("")	,
		nullptr	,
		separators("")	,
		showopt(false)
	)

Definition at line 35 of file Options.h.

◆ doOptimizationPass

Option< bool > nnc::cli::doOptimizationPass	(	optname("-O")	,
		overview("whether to optimize model or not")	,
		false	,
		optional(true)	,
		optvalues("")	,
		nullptr	,
		separators("")	,
		showopt(true)
	)

Options for optimizer

Definition at line 39 of file Options.h.

◆ dumpGraph

Option< bool > nnc::cli::dumpGraph	(	optname("--dump, -D")	,
		overview("dump graph to dot files after optimization passes")	,
		false	,
		optional(true)	,
		optvalues("")	,
		nullptr	,
		separators("")	,
		showopt(true)
	)

Definition at line 40 of file Options.h.

◆ Help

Option< bool > nnc::cli::Help(optname("--help, -h"), overview("print usage and exit"), false, optional(true))	(	optname("--help, -h")	,
		overview("print usage and exit")	,
		false	,
		optional(true)
	)

Options for compiler driver

◆ initNet

Option< std::string > nnc::cli::initNet	(	optname("--init-net")	,
		overview("path to Caffe2 model weights (init_net.pb)")	,
		std::string()	,
		optional(false)	,
		optvalues("")	,
		checkInFile	,
		separators("")	,
		showopt(false)	,
		IOption::Group::caffe2
	)

Definition at line 33 of file Options.h.

◆ inputFile

Option< std::string > nnc::cli::inputFile	(	optname("--nnmodel, -m")	,
		overview("specify input file with serialized NN models")	,
		std::string()	,
		optional(false)	,
		optvalues("")	,
		checkInFile
	)

Options for frontend

Frontend options

Definition at line 52 of file Options.h.

◆ inputShapes

Option< std::vector< int > > nnc::cli::inputShapes	(	optname("--input-shape")	,
		overview("Shape of caffe2 input")	,
		std::vector< int >{}	,
		optional(false)	,
		optvalues("")	,
		nullptr	,
		separators("")	,
		showopt(false)	,
		IOption::Group::caffe2
	)

Definition at line 32 of file Options.h.

◆ interInputDataDir

Option< std::string > nnc::cli::interInputDataDir	(	optname("--input-data-dir")	,
		overview("specify directory with binary files " "containing the input data for the model " "(one file for each input with the same name)")	,
		"."	,
		optional(true)	,
		optvalues("")	,
		checkInDir
	)

Options for interpreter

Options for interpreter

Definition at line 63 of file Options.h.

◆ onnxFrontend

Option< bool > nnc::cli::onnxFrontend	(	optname("--onnx")	,
		overview("treat input file as ONNX model")	,
		false	,
		optional(true)	,
		optvalues("")	,
		nullptr	,
		separators("")	,
		showopt(false)
	)

Definition at line 37 of file Options.h.

◆ target

Option< std::string > nnc::cli::target	(	optname("--target")	,
		overview("select target language to emit for given architecture." "Valid values are '" NNC_TARGET_ARM_CPP "', '" NNC_TARGET_X86_CPP "', '" NNC_TARGET_ARM_GPU_CPP "', '" NNC_TARGET_INTERPRETER "'")	,
		std::string()	,
		optional(false)	,
		optvalues(NNC_TARGET_ARM_CPP "," NNC_TARGET_X86_CPP "," NNC_TARGET_ARM_GPU_CPP "," NNC_TARGET_INTERPRETER)	,
		nullptr	,
		separators("=")
	)

Definition at line 47 of file Options.h.

◆ tflFrontend

Option< bool > nnc::cli::tflFrontend	(	optname("--tflite")	,
		overview("treat input file as Tensor Flow Lite model")	,
		false	,
		optional(true)	,
		optvalues("")	,
		nullptr	,
		separators("")	,
		showopt(false)
	)

Definition at line 36 of file Options.h.

Data Structures

Functions

Variables

Function Documentation

◆ checkInDir()

◆ checkInFile()

◆ checkOutDir()

◆ checkOutFile()

◆ optional()

◆ optname()

◆ optvalues()

◆ overview()

◆ separators()

◆ showopt()

Variable Documentation

◆ artifactDir

◆ artifactName

◆ caffe2Frontend

◆ caffeFrontend

◆ doOptimizationPass

◆ dumpGraph

◆ Help

◆ initNet

◆ inputFile

◆ inputShapes

◆ interInputDataDir

◆ onnxFrontend

◆ target

◆ tflFrontend