mxnet
Public Member Functions | Public Attributes | List of all members
mxnet::OperatorPropertyReg Struct Reference

Registry entry for OperatorProperty factory functions. More...

#include <operator.h>

Inheritance diagram for mxnet::OperatorPropertyReg:
Inheritance graph
Collaboration diagram for mxnet::OperatorPropertyReg:
Collaboration graph

Public Member Functions

OperatorPropertyRegset_key_var_num_args (const std::string &key)
 Set key_var_num_args When this is set, the API caller is required to pass in a argument with key=key_num_args.c_str(), and value=num_args. num_args is number of positional argument when calling the function. More...
 
OperatorPropertyRegcheck_name ()
 Check if TypeString of the type matches the registered name. More...
 
- Public Member Functions inherited from dmlc::FunctionRegEntryBase< OperatorPropertyReg, OperatorPropertyFactory >
OperatorPropertyReg & set_body (OperatorPropertyFactory body)
 Set the function body. More...
 
OperatorPropertyReg & describe (const std::string &description)
 Describe the function. More...
 
OperatorPropertyReg & add_argument (const std::string &name, const std::string &type, const std::string &description)
 Add argument information to the function. More...
 
OperatorPropertyReg & add_arguments (const std::vector< ParamFieldInfo > &args)
 Append list if arguments to the end. More...
 
OperatorPropertyReg & set_return_type (const std::string &type)
 Set the return type. More...
 

Public Attributes

std::string key_var_num_args
 The key num_args name. More...
 
- Public Attributes inherited from dmlc::FunctionRegEntryBase< OperatorPropertyReg, OperatorPropertyFactory >
std::string name
 name of the entry More...
 
std::string description
 description of the entry More...
 
std::vector< ParamFieldInfo > arguments
 additional arguments to the factory function More...
 
OperatorPropertyFactory body
 Function body to create ProductType. More...
 
std::string return_type
 Return type of the function. More...
 

Additional Inherited Members

- Protected Member Functions inherited from dmlc::FunctionRegEntryBase< OperatorPropertyReg, OperatorPropertyFactory >
OperatorPropertyReg & self ()
 

Detailed Description

Registry entry for OperatorProperty factory functions.

Member Function Documentation

◆ check_name()

OperatorPropertyReg& mxnet::OperatorPropertyReg::check_name ( )
inline

Check if TypeString of the type matches the registered name.

◆ set_key_var_num_args()

OperatorPropertyReg& mxnet::OperatorPropertyReg::set_key_var_num_args ( const std::string &  key)
inline

Set key_var_num_args When this is set, the API caller is required to pass in a argument with key=key_num_args.c_str(), and value=num_args. num_args is number of positional argument when calling the function.

This is used to pass in length of positional arguments for operators that can take variable length of input. Most operators do not need to set this property.

Parameters
keythe key name to be set

Member Data Documentation

◆ key_var_num_args

std::string mxnet::OperatorPropertyReg::key_var_num_args

The key num_args name.


The documentation for this struct was generated from the following file: