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

Registry entry for pass functions. More...

#include <pass.h>

Inheritance diagram for nnvm::PassFunctionReg:
Inheritance graph
Collaboration diagram for nnvm::PassFunctionReg:
Collaboration graph

Public Member Functions

PassFunctionRegset_change_graph (bool v)
 Set whether this pass will change graph structure. More...
 
PassFunctionRegprovide_graph_attr (const std::string &attr_name)
 Declare that this pass will generate the given graph attribute name once it is applied on the graph. More...
 
PassFunctionRegdepend_op_attr (const std::string &attr_name)
 Declare this pass requires the given operator attribute to be available before being applied on the graph. More...
 
PassFunctionRegdepend_graph_attr (const std::string &attr_name)
 Declare this pass requires the given graph attribute to be available before being applied on the graph. More...
 
- Public Member Functions inherited from dmlc::FunctionRegEntryBase< PassFunctionReg, PassFunction >
PassFunctionReg & set_body (PassFunctionbody)
 Set the function body. More...
 
PassFunctionReg & describe (const std::string &description)
 Describe the function. More...
 
PassFunctionReg & add_argument (const std::string &name, const std::string &type, const std::string &description)
 Add argument information to the function. More...
 
PassFunctionReg & add_arguments (const std::vector< ParamFieldInfo > &args)
 Append list if arguments to the end. More...
 
PassFunctionReg & set_return_type (const std::string &type)
 Set the return type. More...
 

Public Attributes

bool change_graph {false}
 Whether the pass will change graph structure If this is false, the pass will only change attributes. More...
 
std::vector< std::string > op_attr_dependency
 dependencies on operator attributes More...
 
std::vector< std::string > graph_attr_dependency
 dependencies on attributes in the graph More...
 
std::vector< std::string > graph_attr_targets
 generated targets of graph attributes More...
 
- Public Attributes inherited from dmlc::FunctionRegEntryBase< PassFunctionReg, PassFunction >
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...
 
PassFunction 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< PassFunctionReg, PassFunction >
PassFunctionReg & self ()
 

Detailed Description

Registry entry for pass functions.

Member Function Documentation

PassFunctionReg& nnvm::PassFunctionReg::depend_graph_attr ( const std::string &  attr_name)
inline

Declare this pass requires the given graph attribute to be available before being applied on the graph.

Parameters
attr_nameName of the attribute.
Returns
Reference to self.
PassFunctionReg& nnvm::PassFunctionReg::depend_op_attr ( const std::string &  attr_name)
inline

Declare this pass requires the given operator attribute to be available before being applied on the graph.

Parameters
attr_nameName of the attribute.
Returns
Reference to self.
PassFunctionReg& nnvm::PassFunctionReg::provide_graph_attr ( const std::string &  attr_name)
inline

Declare that this pass will generate the given graph attribute name once it is applied on the graph.

Parameters
attr_nameName of the graph attribute.
Returns
Reference to self.
PassFunctionReg& nnvm::PassFunctionReg::set_change_graph ( bool  v)
inline

Set whether this pass will change graph structure.

Parameters
vIf true, the pass will change graph structure.
Returns
Reference to self.

Member Data Documentation

bool nnvm::PassFunctionReg::change_graph {false}

Whether the pass will change graph structure If this is false, the pass will only change attributes.

std::vector<std::string> nnvm::PassFunctionReg::graph_attr_dependency

dependencies on attributes in the graph

std::vector<std::string> nnvm::PassFunctionReg::graph_attr_targets

generated targets of graph attributes

std::vector<std::string> nnvm::PassFunctionReg::op_attr_dependency

dependencies on operator attributes


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