Library API

Welcome to the developer reference for the MindSpore C++ API.

Class Hierarchy

• • Namespace mindspore
    • Namespace mindspore::api
      • Template Struct ImmTrait
      • Template Struct ImmTrait< bool >
      • Template Struct ImmTrait< float >
      • Template Struct ImmTrait< int64_t >
      • Template Struct ImmTrait< std::string >
      • Template Struct ImmTrait< uint8_t >
      • Class AbstractBase
      • Class AbstractScalar
      • Class AbstractSequence
      • Class AbstractTensor
      • Class AbstractTuple
      • Class AnfNode
      • Class Base
      • Class BoolImm
      • Class CNode
      • Class FloatImm
      • Class FP32Imm
      • Class FuncGraph
      • Class FuncGraphManager
      • Class Int64Imm
      • Class IntegerImm
      • Class LogStream
      • Class LogWriter
      • Class Parameter
      • Class Primitive
      • Class Scalar
      • Class Shape
      • Class StringImm
      • Class Tensor
      • Class TensorType
      • Class Type
      • Class UInt8Imm
      • Class Value
      • Class ValueNode
      • Class ValueSequence
      • Class ValueTuple
      • Enum LogLevel
    • Namespace mindspore::converter
      • Struct ConverterParameters
      • Class ConverterContext
      • Class ModelParser
      • Class NodeParser
      • Enum FmkType
    • Namespace mindspore::dataset
      • Namespace mindspore::dataset::text
        • Class BasicTokenizer
        • Class BertTokenizer
        • Class CaseFold
        • Class FilterWikipediaXML
        • Class JiebaTokenizer
        • Class Lookup
        • Class Ngram
        • Class NormalizeUTF8
        • Class RegexReplace
        • Class RegexTokenizer
        • Class SentencePieceTokenizer
        • Class SlidingWindow
        • Class ToNumber
        • Class ToVectors
        • Class TruncateSequencePair
        • Class UnicodeCharTokenizer
        • Class UnicodeScriptTokenizer
        • Class WhitespaceTokenizer
        • Class WordpieceTokenizer
      • Namespace mindspore::dataset::transforms
        • Class Compose
        • Class Concatenate
        • Class Duplicate
        • Class Fill
        • Class Mask
        • Class OneHot
        • Class PadEnd
        • Class RandomApply
        • Class RandomChoice
        • Class Slice
        • Class TypeCast
        • Class Unique
      • Namespace mindspore::dataset::vision
        • Class AdjustBrightness
        • Class AdjustContrast
        • Class AdjustGamma
        • Class AdjustHue
        • Class AdjustSaturation
        • Class AdjustSharpness
        • Class Affine
        • Class AutoAugment
        • Class AutoContrast
        • Class BoundingBoxAugment
        • Class CenterCrop
        • Class ConvertColor
        • Class Crop
        • Class CutMixBatch
        • Class CutOut
        • Class Decode
        • Class DvppDecodePng
        • Class DvppDecodeResizeCropJpeg
        • Class DvppDecodeResizeJpeg
        • Class DvppDecodeVideo
        • Class Equalize
        • Class Erase
        • Class GaussianBlur
        • Class HorizontalFlip
        • Class HWC2CHW
        • Class Invert
        • Class MixUpBatch
        • Class Normalize
        • Class NormalizePad
        • Class Pad
        • Class PadToSize
        • Class Perspective
        • Class Posterize
        • Class RandAugment
        • Class RandomAdjustSharpness
        • Class RandomAffine
        • Class RandomAutoContrast
        • Class RandomColor
        • Class RandomColorAdjust
        • Class RandomCrop
        • Class RandomCropDecodeResize
        • Class RandomCropWithBBox
        • Class RandomEqualize
        • Class RandomHorizontalFlip
        • Class RandomHorizontalFlipWithBBox
        • Class RandomInvert
        • Class RandomLighting
        • Class RandomPosterize
        • Class RandomResize
        • Class RandomResizedCrop
        • Class RandomResizedCropWithBBox
        • Class RandomResizeWithBBox
        • Class RandomRotation
        • Class RandomSelectSubpolicy
        • Class RandomSharpness
        • Class RandomSolarize
        • Class RandomVerticalFlip
        • Class RandomVerticalFlipWithBBox
        • Class Rescale
        • Class Resize
        • Class ResizedCrop
        • Class ResizePreserveAR
        • Class ResizeWithBBox
        • Class RGB2BGR
        • Class RGB2GRAY
        • Class RGBA2BGR
        • Class RGBA2RGB
        • Class Rotate
        • Class SlicePatches
        • Class Solarize
        • Class SwapRedBlue
        • Class ToTensor
        • Class TrivialAugmentWide
        • Class UniformAugment
        • Class VerticalFlip
      • Struct BoxesConfig
      • Template Struct Chn1
      • Template Struct Chn2
      • Template Struct Chn3
      • Template Struct Chn4
      • Struct imageToolsImage
      • Struct Point
      • Class AlbumDataset
      • Class BatchDataset
      • Class DataHelper
      • Class Dataset
      • Class DistributedSampler
      • Class Execute
      • Class Iterator
        • Class Iterator::_Iterator
      • Class LDataType
      • Class LiteMat
      • Class MapDataset
      • Class MnistDataset
      • Class PKSampler
      • Class ProjectDataset
      • Class PullIterator
      • Class PyExecute
      • Class RandomSampler
      • Class Sampler
      • Class SchemaObj
      • Class SentencePieceVocab
      • Class SequentialSampler
      • Class ShuffleDataset
      • Class Slice
      • Class SliceOption
      • Class SubsetRandomSampler
      • Class SubsetSampler
      • Class TensorTransform
      • Class Vocab
      • Class WeightedRandomSampler
      • Enum AutoAugmentPolicy
      • Enum BorderType
      • Enum ConvertMode
      • Enum DensityFunction
      • Enum FadeShape
      • Enum FixRotationAngle
      • Enum GainType
      • Enum ImageBatchFormat
      • Enum ImageFormat
      • Enum Interpolation
      • Enum InterpolationMode
      • Enum JiebaMode
      • Enum LPixelType
      • Enum ManualOffloadMode
      • Enum MapTargetDevice
      • Enum MelType
      • Enum Modulation
      • Enum NormalizeForm
      • Enum NormMode
      • Enum NormType
      • Enum OutputFormat
      • Enum PaddBorderType
      • Enum RelationalOp
      • Enum ResampleMethod
      • Enum SamplingStrategy
      • Enum ScaleType
      • Enum SentencePieceModel
      • Enum ShuffleMode
      • Enum SliceMode
      • Enum SPieceTokenizerLoadType
      • Enum SPieceTokenizerOutType
      • Enum TensorImpl
      • Enum VdecOutputFormat
      • Enum VdecStreamFormat
      • Enum WARP_BORDER_MODE
      • Enum WindowType
    • Namespace mindspore::kernel
      • Template Class IKernel
      • Class Kernel
      • Class KernelInterface
    • Namespace mindspore::ops
      • Class Abs
      • Class Activation
      • Class Adam
      • Class Add
      • Class AdderFusion
      • Class AddFusion
      • Class AddN
      • Class Affine
      • Class All
      • Class AllGather
      • Class ApplyMomentum
      • Class Argmax
      • Class ArgMaxFusion
      • Class ArgMinFusion
      • Class Assert
      • Class Assign
      • Class AssignAdd
      • Class Attention
      • Class AudioSpectrogram
      • Class AvgPool
      • Class AvgPoolFusion
      • Class BaseOperator
      • Class BatchNorm
      • Class BatchNormWithActivation
      • Class BatchNormWithAddAndActivation
      • Class BatchToSpace
      • Class BatchToSpaceND
      • Class BiasAdd
      • Class BinaryCrossEntropy
      • Class Broadcast
      • Class Call
      • Class Cast
      • Class Ceil
      • Class Clip
      • Class Concat
      • Class ConstantOfShape
      • Class Conv2D
      • Class Conv2DBackpropFilterFusion
      • Class Conv2DBackpropInputFusion
      • Class Conv2DFusion
      • Class Conv2DTranspose
      • Class Conv2dTransposeFusion
      • Class Cos
      • Class Crop
      • Class CropAndResize
      • Class CudnnUniformReal
      • Class CumSum
      • Class Custom
      • Class CustomExtractFeatures
      • Class CustomNormalize
      • Class CustomPredict
      • Class Depend
      • Class DepthToSpace
      • Class DetectionPostProcess
      • Class Div
      • Class DivFusion
      • Class Dropout
      • Class DynamicQuant
      • Class Eltwise
      • Class Elu
      • Class EmbeddingLookupFusion
      • Class Equal
      • Class Erf
      • Class Exp
      • Class ExpandDims
      • Class ExpFusion
      • Class FakeQuantWithMinMaxVars
      • Class FakeQuantWithMinMaxVarsPerChannel
      • Class FftImag
      • Class FftReal
      • Class Fill
      • Class Flatten
      • Class Floor
      • Class FloorDiv
      • Class FloorMod
      • Class FullConnection
      • Class FusedBatchNorm
      • Class Gather
      • Class GatherNd
      • Class GLU
      • Class Greater
      • Class GreaterEqual
      • Class GRU
      • Class HashtableLookup
      • Class InstanceNorm
      • Class InvertPermutation
      • Class IsFinite
      • Class L2NormalizeFusion
      • Class LayerNormFusion
      • Class LeakyRelu
      • Class Less
      • Class LessEqual
      • Class LinSpace
      • Class Log
      • Class LogicalAnd
      • Class LogicalNot
      • Class LogicalOr
      • Class LogSoftmax
      • Class LpNormalization
      • Class LRN
      • Class LshProjection
      • Class LSTM
      • Class MakeTuple
      • Class MatMulFusion
      • Class Maximum
      • Class MaxPool
      • Class MaxPoolFusion
      • Class Mfcc
      • Class Minimum
      • Class Mod
      • Class Mul
      • Class MulFusion
      • Class Neg
      • Class NLLLoss
      • Class NonMaxSuppression
      • Class NonZero
      • Class NotEqual
      • Class OneHot
      • Class OnesLike
      • Class OperatorRegister
      • Class OperatorRegisterHelper
      • Class Pad
      • Class PadFusion
      • Class PartialFusion
      • Class Pow
      • Class PowFusion
      • Class PReLU
      • Class PReLUFusion
      • Class PriorBox
      • Class QuantDTypeCast
      • Class RaggedRange
      • Class RandomNormal
      • Class RandomStandardNormal
      • Class Range
      • Class Rank
      • Class RealDiv
      • Class Reciprocal
      • Class Reduce
      • Class ReduceFusion
      • Class ReduceScatter
      • Class Reshape
      • Class Resize
      • Class Return
      • Class ReverseSequence
      • Class ReverseV2
      • Class Rfft
      • Class ROIPooling
      • Class Round
      • Class Rsqrt
      • Class Scale
      • Class ScaleFusion
      • Class ScatterNd
      • Class ScatterNdUpdate
      • Class Select
      • Class SGD
      • Class Shape
      • Class SigmoidCrossEntropyWithLogits
      • Class Sin
      • Class Size
      • Class SkipGram
      • Class SliceFusion
      • Class SmoothL1Loss
      • Class Softmax
      • Class SoftmaxCrossEntropyWithLogits
      • Class SpaceToBatch
      • Class SpaceToBatchND
      • Class SpaceToDepth
      • Class SparseSoftmaxCrossEntropyWithLogits
      • Class SparseToDense
      • Class Splice
      • Class Split
      • Class SplitWithOverlap
      • Class Sqrt
      • Class Square
      • Class SquaredDifference
      • Class Squeeze
      • Class Stack
      • Class StridedSlice
      • Class Sub
      • Class SubFusion
      • Class Switch
      • Class SwitchLayer
      • Class TensorArray
      • Class TensorArrayRead
      • Class TensorArrayWrite
      • Class TensorListFromTensor
      • Class TensorListGetItem
      • Class TensorListReserve
      • Class TensorListSetItem
      • Class TensorListStack
      • Class Tile
      • Class TileFusion
      • Class TopK
      • Class TopKFusion
      • Class Transpose
      • Class TupleGetItem
      • Class UniformReal
      • Class Unique
      • Class UnsortedSegmentSum
      • Class Unsqueeze
      • Class Unstack
      • Class Where
      • Class ZerosLike
    • Namespace mindspore::registry
      • Namespace mindspore::registry::opencl
        • Class OpenCLRuntimeWrapper
      • Struct KernelDesc
      • Struct KernelDescHelper
      • Class KernelInterfaceReg
      • Class KernelReg
      • Class ModelParserRegistry
      • Class NodeParserRegistry
      • Class PassBase
      • Class PassRegistry
      • Class RegisterKernel
      • Class RegisterKernelInterface
      • Enum PassPosition
    • Struct MSCallBackParam
    • Struct QuantParam
    • Struct StepLRLambda
    • Struct TrainCallBackData
    • Class Allocator
    • Class AscendDeviceInfo
    • Class Buffer
    • Template Class Cell
    • Class CellBase
    • Class CkptSaver
    • Class Context
    • Class Converter
    • Class CoreMLDelegate
    • Class CPUDeviceInfo
    • Class Delegate
    • Template Class DelegateModel
    • Class DeviceInfoContext
    • Class GPUDeviceInfo
    • Class Graph
    • Class GraphCell
    • Class InputAndOutput
    • Class KirinNPUDeviceInfo
    • Class LossMonitor
    • Class LRScheduler
    • Class Model
    • Class ModelParallelRunner
    • Class MSTensor
    • Class RunnerConfig
    • Class Serialization
    • Class Status
    • Class TimeMonitor
    • Class TrainAccuracy
    • Class TrainCallBack
    • Enum CallbackRetValue
    • Enum CompCode
    • Enum DataType
    • Enum DeviceType
    • Enum Format
    • Enum Format
    • Enum ModelType
    • Enum OptimizationLevel
    • Enum QuantizationType
    • Enum SchemaVersion
    • Enum StatusCode
  • Struct MSCallBackParamC
  • Struct MSShapeInfo
  • Struct MSTensorHandleArray
  • Enum MSDataType
  • Enum MSDeviceType
  • Enum MSFormat
  • Enum MSModelType

File Hierarchy

• • Directory include
    • Directory converter
      • Directory include
        • Directory core
          • Directory abstract
            • File abstract_value.h
            • File dshape.h
            • File param_validator.h
            • File primitive_infer_map.h
            • File utils.h
          • Directory base
            • File base.h
            • File base_ref.h
            • File effect_info.h
            • File float16.h
            • File user_data.h
          • Directory ir
            • Directory dtype
              • File container.h
              • File empty.h
              • File monad_type.h
              • File number.h
              • File ref.h
              • File tensor_type.h
              • File type.h
              • File type_id.h
            • File anf.h
            • File device_event.h
            • File device_sync.h
            • File dtype.h
            • File func_graph.h
            • File func_graph_cloner.h
            • File graph_utils.h
            • File kernel_info_dev.h
            • File manager.h
            • File meta_tensor.h
            • File named.h
            • File param_info.h
            • File primal_attr.h
            • File primal_debug_info.h
            • File primitive.h
            • File scalar.h
            • File scope.h
            • File signature.h
            • File tensor.h
            • File value.h
          • Directory mindapi
            • Directory base
              • File base.h
              • File format.h
              • File logging.h
              • File macros.h
              • File shape_vector.h
              • File shared_ptr.h
              • File type_id.h
              • File type_traits.h
              • File types.h
            • Directory ir
              • File abstract.h
              • File anf.h
              • File common.h
              • File func_graph.h
              • File primitive.h
              • File shape.h
              • File tensor.h
              • File type.h
              • File utils.h
              • File value.h
          • Directory ops
            • Directory fusion
              • File activation.h
              • File add_fusion.h
              • File adder_fusion.h
              • File arg_max_fusion.h
              • File arg_min_fusion.h
              • File avg_pool_fusion.h
              • File conv2d_backprop_filter_fusion.h
              • File conv2d_backprop_input_fusion.h
              • File conv2d_fusion.h
              • File conv2d_transpose_fusion.h
              • File div_fusion.h
              • File embedding_lookup_fusion.h
              • File exp_fusion.h
              • File full_connection.h
              • File l2_normalize_fusion.h
              • File layer_norm_fusion.h
              • File mat_mul_fusion.h
              • File max_pool_fusion.h
              • File mul_fusion.h
              • File pad_fusion.h
              • File partial_fusion.h
              • File pow_fusion.h
              • File prelu_fusion.h
              • File reduce_fusion.h
              • File scale_fusion.h
              • File slice_fusion.h
              • File sub_fusion.h
              • File tile_fusion.h
              • File topk_fusion.h
            • File abs.h
            • File adam.h
            • File add.h
            • File addn.h
            • File affine.h
            • File all.h
            • File all_gather.h
            • File apply_momentum.h
            • File arg_max.h
            • File assert.h
            • File assign.h
            • File assign_add.h
            • File attention.h
            • File audio_spectrogram.h
            • File avg_pool.h
            • File base_operator.h
            • File batch_norm.h
            • File batch_to_space.h
            • File batch_to_space_nd.h
            • File bias_add.h
            • File binary_cross_entropy.h
            • File broadcast.h
            • File call.h
            • File cast.h
            • File ceil.h
            • File clip.h
            • File concat.h
            • File constant_of_shape.h
            • File conv2d.h
            • File conv2d_transpose.h
            • File cos.h
            • File crop.h
            • File crop_and_resize.h
            • File cumsum.h
            • File custom.h
            • File custom_extract_features.h
            • File custom_normalize.h
            • File custom_predict.h
            • File depend.h
            • File depth_to_space.h
            • File detection_post_process.h
            • File div.h
            • File dropout.h
            • File dynamic_quant.h
            • File eltwise.h
            • File elu.h
            • File equal.h
            • File erf.h
            • File exp.h
            • File expand_dims.h
            • File fake_quant_with_min_max_vars.h
            • File fake_quant_with_min_max_vars_per_channel.h
            • File fft_imag.h
            • File fft_real.h
            • File fill.h
            • File flatten.h
            • File floor.h
            • File floor_div.h
            • File floor_mod.h
            • File fused_batch_norm.h
            • File gather.h
            • File gather_nd.h
            • File glu.h
            • File greater.h
            • File greater_equal.h
            • File gru.h
            • File hashtable_lookup.h
            • File instance_norm.h
            • File invert_permutation.h
            • File is_finite.h
            • File leaky_relu.h
            • File less.h
            • File less_equal.h
            • File lin_space.h
            • File log.h
            • File log_softmax.h
            • File logical_and.h
            • File logical_not.h
            • File logical_or.h
            • File lp_normalization.h
            • File lrn.h
            • File lsh_projection.h
            • File lstm.h
            • File make_tuple.h
            • File max_pool.h
            • File maximum.h
            • File mfcc.h
            • File minimum.h
            • File mod.h
            • File mul.h
            • File neg.h
            • File nllloss.h
            • File non_max_suppression.h
            • File non_zero.h
            • File not_equal.h
            • File one_hot.h
            • File ones_like.h
            • File op_name.h
            • File pad.h
            • File pow.h
            • File prelu.h
            • File prior_box.h
            • File quant_dtype_cast.h
            • File ragged_range.h
            • File random_normal.h
            • File random_standard_normal.h
            • File range.h
            • File rank.h
            • File real_div.h
            • File reciprocal.h
            • File reduce.h
            • File reduce_scatter.h
            • File reshape.h
            • File resize.h
            • File return.h
            • File reverse_sequence.h
            • File reverse_v2.h
            • File rfft.h
            • File roi_pooling.h
            • File round.h
            • File rsqrt.h
            • File scale.h
            • File scatter_nd.h
            • File scatter_nd_update.h
            • File select.h
            • File sgd.h
            • File shape.h
            • File sigmoid_cross_entropy_with_logits.h
            • File sin.h
            • File size.h
            • File skip_gram.h
            • File smooth_l1_loss.h
            • File softmax.h
            • File softmax_cross_entropy_with_logits.h
            • File space_to_batch.h
            • File space_to_batch_nd.h
            • File space_to_depth.h
            • File sparse_softmax_cross_entropy_with_logits.h
            • File sparse_to_dense.h
            • File splice.h
            • File split.h
            • File split_with_overlap.h
            • File sqrt.h
            • File square.h
            • File squared_difference.h
            • File squeeze.h
            • File stack.h
            • File strided_slice.h
            • File sub.h
            • File switch.h
            • File switch_layer.h
            • File tensor_array.h
            • File tensor_array_read.h
            • File tensor_array_write.h
            • File tensor_list_from_tensor.h
            • File tensor_list_get_item.h
            • File tensor_list_reserve.h
            • File tensor_list_set_item.h
            • File tensor_list_stack.h
            • File tile.h
            • File topk.h
            • File transpose.h
            • File tuple_get_item.h
            • File uniform_real.h
            • File unique.h
            • File unsorted_segment_sum.h
            • File unsqueeze.h
            • File unstack.h
            • File where.h
            • File zeros_like.h
          • Directory utils
            • File any.h
            • File check_convert_utils.h
            • File compact_set.h
            • File convert_utils_base.h
            • File flags.h
            • File hash_map.h
            • File hash_set.h
            • File hashing.h
            • File info.h
            • File label.h
            • File log_adapter.h
            • File macros.h
            • File misc.h
            • File ms_exception.h
            • File ms_utils.h
            • File ordered_map.h
            • File ordered_set.h
            • File overload.h
            • File shape_utils.h
            • File signal.h
            • File trace_info.h
        • Directory registry
          • File converter_context.h
          • File model_parser.h
          • File model_parser_registry.h
          • File node_parser.h
          • File node_parser_registry.h
          • File opencl_runtime_wrapper.h
          • File pass_base.h
          • File pass_registry.h
          • File register_kernel.h
          • File register_kernel_interface.h
        • File converter.h
        • File kernel_interface.h
    • Directory runtime
      • Directory include
        • Directory api
          • Directory callback
            • File callback.h
            • File ckpt_saver.h
            • File loss_monitor.h
            • File lr_scheduler.h
            • File time_monitor.h
            • File train_accuracy.h
          • Directory metrics
            • File accuracy.h
            • File metrics.h
          • File allocator.h
          • File cell.h
          • File cfg.h
          • File context.h
          • File data_type.h
          • File delegate.h
          • File delegate_api.h
          • File dual_abi_helper.h
          • File format.h
          • File graph.h
          • File kernel.h
          • File kernel_api.h
          • File model.h
          • File model_parallel_runner.h
          • File net.h
          • File serialization.h
          • File status.h
          • File types.h
          • File visible.h
        • Directory api
          • File context_c.h
          • File data_type_c.h
          • File format_c.h
          • File model_c.h
          • File status_c.h
          • File tensor_c.h
          • File types_c.h
        • Directory dataset
          • Directory cv
            • File image_process.h
            • File lite_mat.h
          • File config.h
          • File constants.h
          • File data_helper.h
          • File datasets.h
          • File execute.h
          • File iterator.h
          • File samplers.h
          • File text.h
          • File transforms.h
          • File vision.h
          • File vision_ascend.h
          • File vision_lite.h
        • Directory ir
          • Directory dtype
            • File type_id.h
        • Directory mindapi
          • Directory base
            • File format.h
            • File type_id.h
            • File types.h
        • Directory registry
          • File register_kernel.h
          • File register_kernel_interface.h
        • File kernel_interface.h

• caffe

• mindspore::abstract

• mindspore::api
  • Namespaces
  • Classes
  • Enums
  • Functions

• mindspore::api::utils
  • Functions

• mindspore::converter
  • Classes
  • Enums

• mindspore::dataset
  • Namespaces
  • Classes
  • Enums
  • Functions

• mindspore::dataset::config
  • Functions

• mindspore::dataset::text
  • Classes

• mindspore::dataset::transforms
  • Classes

• mindspore::dataset::vision
  • Classes
  • Functions

• mindspore::kernel
  • Classes

• mindspore::ops
  • Classes
  • Functions

• mindspore::registry
  • Namespaces
  • Classes
  • Enums

• mindspore::registry::opencl
  • Classes

• onnx

• tensorflow

• tflite