C++ API¶

Class Hierarchy¶

- Namespace mgb
  - Namespace mgb::cg
    - Namespace mgb::cg::event
      - Struct AfterKernel
      - Struct AfterWait
      - Struct BeforeKernel
      - Struct CompSeqExecBeforeStart
      - Struct CompSeqExecError
      - Struct CompSeqExecFinished
      - Struct CompSeqOrderDetermined
      - Struct OprExecFinished
      - Struct OprExecKernelEnd
      - Struct OprExecKernelStart
      - Struct OprExecStart
      - Struct OprInserted
      - Struct StaticMemAlloc
      - Struct SubgraphAssociated
    - Namespace mgb::cg::mixin
      - Template Class CheckBase
      - Class EmptyMixinImpl
      - Class IOSameShapeOperatorNode
      - Class OutshapePureByInshapeOpr
      - Class SingleCNOperatorNode
    - Struct GraphCommonOptimizeOptions
    - Class ComputingGraph
      - Struct ComputingGraph::Options
        Struct Options::GraphOpt
        Struct Options::OprAttribute
        Struct Options::SeqOpt
        Struct Options::SublinearMemConfig
      - Struct ComputingGraph::VarReceiverInfo
    - Class DeviceMemoryAllocator
    - Class GraphExecutable
      - Class GraphExecutable::ExecDependency
      - Class GraphExecutable::ExecEnv
    - Class MemAllocPlan
      - Class MemAllocPlan::Chunk
        Class Chunk::MemAllocStatus
      - Class MemAllocPlan::ReadonlyFwdList
    - Class OperatorNodeBase
      - Struct OperatorNodeBase::CtorParamPack
      - Struct OperatorNodeBase::InputWaitingSpecElem
      - Struct OperatorNodeBase::OprEventCallback
    - Class OperatorNodeConfig
    - Class OperatorNodeMixinBase
    - Class OperatorNodeProp
      - Struct OperatorNodeProp::Attribute
        Struct Attribute::GradTracker
        Class Attribute::Accessory
    - Class SymbolVar
    - Class SymbolVarArrayView
    - Class VarNode
    - Class VarNodeArrayView
  - Namespace mgb::comp_node_detail
    - Class DepedentObjList
  - Namespace mgb::gopt
    - Struct OptimizeForInferenceOptions
    - Class ConvertBatchNormToElemwisePass
    - Class ConvertF32ToF16Pass
    - Class ConvertFormatPass
    - Class EnableCHWN4Pass
    - Class EnableNchw44DotPass
    - Class EnableNCHW4Pass
    - Class EnableNchwxxPass
    - Class EnableTensorCorePass
    - Class FuseConvBiasNonlinPass
    - Class FuseConvBiasZPass
    - Class FuseDeconvCvtPass
    - Class ParamFusePass
    - Class ParamMergePass
    - Class ParamRedistributePass
    - Class ShuffleShuffleRemovePass
    - Class TensorReformatPass
  - Namespace mgb::serialization
    - Struct GraphDumpConfig
    - Struct GraphLoadConfig
    - Class GraphDumper
      - Struct GraphDumper::DumpResult
    - Class GraphLoader
      - Struct GraphLoader::LoadResult
    - Class InputFile
    - Class OutputFile
    - Class SharedBuffer
  - Template Struct ctype_enable_if
  - Template Struct HashTrait< CompNode >
  - Class AssertionError
  - Class AtlasError
  - Class BinaryOprIODump
  - Class CndevError
  - Class CnmlError
  - Class CnrtError
  - Class CompNode
    - Struct CompNode::Locator
    - Struct CompNode::Stream
    - Class CompNode::Event
    - Class CompNode::EventPool
    - Class CompNode::ImplBase
  - Class CompNodeDepedentObject
  - Class ConversionError
  - Class CPUDispatchChecker
  - Class CudaError
  - Class InfkernFinder
    - Struct InfkernFinder::InputValueRecord
  - Class InternalError
  - Class MegBrainError
    - Class MegBrainError::ExtraInfo
  - Class MegDNNError
  - Class MemAllocError
  - Class MemNode
  - Class NumRangeChecker
    - Class NumRangeChecker::Checker
  - Class NumRangeCheckerError
  - Class OprFootprint
    - Struct OprFootprint::Result
  - Class OprIODumpBase
  - Template Class OutshapePureByInshapeOpr
  - Class PluginBase
  - Class ROCmError
  - Class SerializationError
  - Class Slice
  - Class SubTensorSpec
  - Class SystemError
  - Class TensorCopyOverlapError
  - Template Class TensorND
  - Class TensorReshapeError
  - Template Class TensorStorage
  - Class TextOprIODump
  - Class TimeoutError
  - Class VarSanityCheck
    - Struct VarSanityCheck::WorkspaceCache
    - Class VarSanityCheck::DebugLog
  - Class VarSanityCheckError
  - Class VarValueChecker
    - Class VarValueChecker::Checker

File Hierarchy¶

- Directory file
  - Directory megbrain
    - Directory gopt
      - File inference.h
    - Directory graph
      - File cg.h
      - File event.h
      - File operator_node.h
      - File symbol_var.h
      - File var_node.h
    - Directory plugin
      - File base.h
      - File cpu_dispatch_checker.h
      - File infkern_finder.h
      - File num_range_checker.h
      - File opr_footprint.h
      - File opr_io_dump.h
      - File profiler.h
      - File var_sanity_check.h
      - File var_value_checker.h
    - Directory serialization
      - File file.h
      - File load_dump_config.h
      - File serializer.h
    - Directory utils
      - File debug.h
    - File comp_node.h
    - File dtype.h
    - File exception.h
    - File tensor.h
- File h_file.txt

Full API¶

Classes and Structs¶

Struct ComputingGraph::Options
- Nested Relationships
  - Nested Types
- Struct Documentation

Struct Options::GraphOpt

Struct Options::OprAttribute
- Nested Relationships
- Struct Documentation

Struct Options::SeqOpt
- Nested Relationships
- Struct Documentation

Struct Options::SublinearMemConfig
- Nested Relationships
- Struct Documentation

Struct ComputingGraph::VarReceiverInfo
- Nested Relationships
- Struct Documentation

Struct AfterKernel
- Struct Documentation

Struct AfterWait
- Struct Documentation

Struct BeforeKernel
- Struct Documentation

Struct CompSeqExecBeforeStart
- Struct Documentation

Struct CompSeqExecError
- Struct Documentation

Struct CompSeqExecFinished
- Struct Documentation

Struct CompSeqOrderDetermined
- Struct Documentation

Struct OprExecFinished
- Struct Documentation

Struct OprExecKernelEnd
- Struct Documentation

Struct OprExecKernelStart
- Struct Documentation

Struct OprExecStart
- Struct Documentation

Struct OprInserted
- Struct Documentation

Struct StaticMemAlloc
- Struct Documentation

Struct SubgraphAssociated
- Struct Documentation

Struct GraphCommonOptimizeOptions
- Inheritance Relationships
  - Derived Types
- Struct Documentation

Struct OperatorNodeBase::CtorParamPack
- Nested Relationships
- Struct Documentation

Struct OperatorNodeBase::InputWaitingSpecElem
- Nested Relationships
- Struct Documentation

Struct OperatorNodeBase::OprEventCallback
- Nested Relationships
- Struct Documentation

Struct OperatorNodeProp::Attribute
- Nested Relationships
  - Nested Types
- Struct Documentation

Struct Attribute::GradTracker
- Nested Relationships
- Struct Documentation

Struct CompNode::Locator
- Nested Relationships
- Struct Documentation

Struct CompNode::Stream
- Nested Relationships
- Struct Documentation

Template Struct ctype_enable_if
- Struct Documentation

Struct OptimizeForInferenceOptions
- Inheritance Relationships
  - Base Type
- Struct Documentation

Template Struct HashTrait< CompNode >
- Struct Documentation

Struct InfkernFinder::InputValueRecord
- Nested Relationships
- Struct Documentation

Struct OprFootprint::Result
- Nested Relationships
- Struct Documentation

Struct GraphDumpConfig
- Struct Documentation

Struct GraphDumper::DumpResult
- Nested Relationships
- Struct Documentation

Struct GraphLoadConfig
- Struct Documentation

Struct GraphLoader::LoadResult
- Nested Relationships
- Struct Documentation

Struct VarSanityCheck::WorkspaceCache
- Nested Relationships
- Struct Documentation

Class AssertionError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class AtlasError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class BinaryOprIODump
- Inheritance Relationships
  - Base Type
- Class Documentation

Class ComputingGraph

Class DeviceMemoryAllocator
- Class Documentation

Class GraphExecutable

Class GraphExecutable::ExecDependency
- Nested Relationships
- Class Documentation

Class GraphExecutable::ExecEnv
- Nested Relationships
- Class Documentation

Class MemAllocPlan

Class MemAllocPlan::Chunk

Class Chunk::MemAllocStatus
- Nested Relationships
- Class Documentation

Class MemAllocPlan::ReadonlyFwdList
- Nested Relationships
- Class Documentation

Template Class CheckBase
- Class Documentation

Class EmptyMixinImpl
- Class Documentation

Class IOSameShapeOperatorNode
- Inheritance Relationships
  - Base Type
- Class Documentation

Class OutshapePureByInshapeOpr
- Inheritance Relationships
  - Base Type
  - Derived Type
- Class Documentation

Class SingleCNOperatorNode
- Inheritance Relationships
  - Base Type
- Class Documentation

Class OperatorNodeBase

Class OperatorNodeConfig
- Inheritance Relationships
  - Base Type
- Class Documentation

Class OperatorNodeMixinBase
- Inheritance Relationships
  - Base Type
  - Derived Types
- Class Documentation

Class OperatorNodeProp

Class Attribute::Accessory
- Nested Relationships
- Class Documentation

Class SymbolVar
- Class Documentation

Class SymbolVarArrayView
- Inheritance Relationships
  - Base Type
- Class Documentation

Class VarNode
- Inheritance Relationships
  - Base Type
- Class Documentation

Class VarNodeArrayView
- Inheritance Relationships
  - Base Type
- Class Documentation

Class CndevError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class CnmlError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class CnrtError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class DepedentObjList
- Inheritance Relationships
  - Derived Type
- Class Documentation

Class CompNode
- Nested Relationships
  - Nested Types
- Class Documentation

Class CompNode::Event

Class CompNode::EventPool
- Nested Relationships
- Class Documentation

Class CompNode::ImplBase

Class CompNodeDepedentObject
- Inheritance Relationships
  - Base Type
  - Derived Type
- Class Documentation

Class ConversionError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class CPUDispatchChecker
- Inheritance Relationships
  - Base Type
- Class Documentation

Class CudaError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class ConvertBatchNormToElemwisePass
- Inheritance Relationships
  - Base Type
- Class Documentation

Class ConvertF32ToF16Pass
- Inheritance Relationships
  - Base Type
- Class Documentation

Class ConvertFormatPass
- Inheritance Relationships
  - Base Type
- Class Documentation

Class EnableCHWN4Pass
- Inheritance Relationships
  - Base Type
- Class Documentation

Class EnableNchw44DotPass
- Inheritance Relationships
  - Base Type
- Class Documentation

Class EnableNCHW4Pass
- Inheritance Relationships
  - Base Type
- Class Documentation

Class EnableNchwxxPass
- Inheritance Relationships
  - Base Type
  - Derived Type
- Class Documentation

Class EnableTensorCorePass
- Inheritance Relationships
  - Base Type
- Class Documentation

Class FuseConvBiasNonlinPass
- Inheritance Relationships
  - Base Type
- Class Documentation

Class FuseConvBiasZPass
- Inheritance Relationships
  - Base Type
- Class Documentation

Class FuseDeconvCvtPass
- Inheritance Relationships
  - Base Type
- Class Documentation

Class ParamFusePass
- Inheritance Relationships
  - Base Type
- Class Documentation

Class ParamMergePass
- Inheritance Relationships
  - Base Type
- Class Documentation

Class ParamRedistributePass
- Inheritance Relationships
  - Base Type
- Class Documentation

Class ShuffleShuffleRemovePass
- Inheritance Relationships
  - Base Type
- Class Documentation

Class TensorReformatPass
- Inheritance Relationships
  - Base Type
  - Derived Types
- Class Documentation

Class InfkernFinder

Class InternalError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class MegBrainError

Class MegBrainError::ExtraInfo
- Nested Relationships
- Class Documentation

Class MegDNNError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class MemAllocError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class MemNode
- Class Documentation

Class NumRangeChecker

Class NumRangeChecker::Checker
- Nested Relationships
- Class Documentation

Class NumRangeCheckerError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class OprFootprint
- Nested Relationships
  - Nested Types
- Class Documentation

Class OprIODumpBase
- Inheritance Relationships
  - Base Type
  - Derived Types
- Class Documentation

Template Class OutshapePureByInshapeOpr
- Inheritance Relationships
  - Base Types
- Class Documentation

Class PluginBase
- Inheritance Relationships
  - Base Type
  - Derived Types
- Class Documentation

Class ROCmError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class GraphDumper
- Nested Relationships
  - Nested Types
- Class Documentation

Class GraphLoader
- Nested Relationships
  - Nested Types
- Class Documentation

Class InputFile
- Class Documentation

Class OutputFile
- Class Documentation

Class SharedBuffer
- Class Documentation

Class SerializationError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class Slice
- Class Documentation

Class SubTensorSpec
- Class Documentation

Class SystemError
- Inheritance Relationships
  - Base Type
  - Derived Types
- Class Documentation

Class TensorCopyOverlapError
- Inheritance Relationships
  - Base Type
- Class Documentation

Template Class TensorND
- Class Documentation

Class TensorReshapeError
- Inheritance Relationships
  - Base Type
- Class Documentation

Template Class TensorStorage
- Class Documentation

Class TextOprIODump
- Inheritance Relationships
  - Base Type
- Class Documentation

Class TimeoutError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class VarSanityCheck

Class VarSanityCheck::DebugLog
- Nested Relationships
- Class Documentation

Class VarSanityCheckError
- Inheritance Relationships
  - Base Type
- Class Documentation

Class VarValueChecker

Class VarValueChecker::Checker
- Nested Relationships
- Class Documentation

Functions¶

Function mgb::cg::comp_node()
- Function Documentation

Function mgb::cg::comp_node(CompNode)
- Function Documentation

Function mgb::cg::do_execute
- Function Documentation

Function mgb::cg::do_make_node_prop
- Function Documentation

Function mgb::cg::init_output_comp_node
- Function Documentation

Function mgb::cg::MGB_DEF_ENUM_CLASS_BIT_OPR
- Function Documentation

Function mgb::cg::on_output_comp_node_stream_changed
- Function Documentation

Template Function mgb::cg::operator*
- Function Documentation

Template Function mgb::cg::operator+
- Function Documentation

Template Function mgb::cg::operator-
- Function Documentation

Template Function mgb::cg::operator/
- Function Documentation

Template Function mgb::cg::operator<
- Function Documentation

Template Function mgb::cg::operator<=
- Function Documentation

Template Function mgb::cg::operator>
- Function Documentation

Function mgb::debug::compare_tensor_value
- Function Documentation

Function mgb::debug::dump_tensor(const HostTensorND&, const std::string&)
- Function Documentation

Function mgb::debug::dump_tensor(const DeviceTensorND&, const std::string&)
- Function Documentation

Function mgb::debug::write_to_file
- Function Documentation

Function mgb::dev_tensor_memset
- Function Documentation

Function mgb::dtype_promotion
- Function Documentation

Function mgb::fill_zero_dev_tensor
- Function Documentation

Function mgb::gopt::enable_opr_algo_profiling_inplace
- Function Documentation

Function mgb::gopt::enable_opr_use_profiling_cache_inplace
- Function Documentation

Function mgb::gopt::modify_opr_algo_strategy_inplace
- Function Documentation

Function mgb::gopt::optimize_for_inference
- Function Documentation

Function mgb::gopt::set_opr_algo_workspace_limit_inplace
- Function Documentation

Function mgb::has_uncaught_exception
- Function Documentation

Function mgb::lowbit_memcpy_byte2compact
- Function Documentation

Function mgb::lowbit_memcpy_compact2byte
- Function Documentation

Function mgb::MEGDNN_FOREACH_COMPUTING_DTYPE
- Function Documentation

Function mgb::MGB_DEF_ENUM_CLASS_BIT_OPR
- Function Documentation

Template Function mgb::static_cast_dtype
- Function Documentation

Template Function mgb::static_cast_dtype_safe
- Function Documentation