Python API Reference

• Common
  • Config
  • Logger
    • logger
  • Auto-forward mode
    • auto_forward()
    • set_auto_forward()
    • get_auto_forward()
  • Context
    • Context
    • Context Specifier API
      • context_scope()
      • set_default_context()
      • get_current_context()
• NdArray
  • NdArray
    • NdArray.bool_fill()
    • NdArray.cast()
    • NdArray.clear()
    • NdArray.clear_called
    • NdArray.copy_from()
    • NdArray.data
    • NdArray.data_ptr()
    • NdArray.dtype
    • NdArray.fill()
    • NdArray.from_numpy_array()
    • NdArray.get_data()
    • NdArray.masked_fill()
    • NdArray.modification_count
    • NdArray.narrow()
    • NdArray.ndim
    • NdArray.shape
    • NdArray.size
    • NdArray.size_from_axis()
    • NdArray.strides
    • NdArray.view()
    • NdArray.zero()
    • NdArray.zeroing
• Variable
  • Variable
    • Variable.apply()
    • Variable.backward()
    • Variable.bool_fill_()
    • Variable.clear_all_graph_links()
    • Variable.d
    • Variable.data
    • Variable.forward()
    • Variable.from_numpy_array()
    • Variable.function_references
    • Variable.g
    • Variable.get_number_of_references
    • Variable.get_unlinked_variable()
    • Variable.grad
    • Variable.info
    • Variable.masked_fill_()
    • Variable.ndim
    • Variable.need_grad
    • Variable.no_grad()
    • Variable.parent
    • Variable.persistent
    • Variable.recompute
    • Variable.reset_shape()
    • Variable.reshape()
    • Variable.rewire_on()
    • Variable.shape
    • Variable.size
    • Variable.size_from_axis()
    • Variable.unlinked()
    • Variable.visit()
    • Variable.visit_check()
• Computation Graph
  • Computation Graph
    • forward_all()
    • no_grad()
• Functions
  • Function
    • Function
      • Function.args
      • Function.auto_grad_depends_input_data()
      • Function.auto_grad_depends_output_data()
      • Function.backward()
      • Function.forward()
      • Function.grad_depends_input_data()
      • Function.grad_depends_output_data()
      • Function.info
      • Function.inplace_data()
      • Function.inplace_data_with()
      • Function.min_outputs()
      • Function.need_setup_recompute()
      • Function.recompute()
      • Function.set_active_input_mask()
      • Function.setup()
      • Function.setup_recompute()
      • Function.tags
    • PythonFunction
      • PythonFunction.__init__()
      • PythonFunction.backward_impl()
      • PythonFunction.ctx
      • PythonFunction.forward_impl()
      • PythonFunction.grad_depends_input_data()
      • PythonFunction.grad_depends_output_data()
      • PythonFunction.min_outputs()
      • PythonFunction.name
      • PythonFunction.setup_impl()
  • List of Functions
    • Neural Network Layers
      • affine()
      • convolution()
      • depthwise_convolution()
      • deconvolution()
      • depthwise_deconvolution()
      • deformable_convolution()
      • adaptive_separable_convolution()
      • max_pooling()
      • average_pooling()
      • global_average_pooling()
      • sum_pooling()
      • unpooling()
      • embed()
      • rnn()
      • lstm()
      • gru()
      • multi_head_attention()
      • patch_correlation()
      • roi_align()
    • Neural Network Activation
      • sigmoid()
      • swish()
      • tanh()
      • relu()
      • softmax()
      • log_softmax()
      • elu()
      • selu()
      • crelu()
      • celu()
      • gelu()
      • mish()
      • prelu()
      • leaky_relu()
      • relu6()
      • hard_sigmoid()
      • hard_tanh()
      • log_sigmoid()
      • softplus()
      • softsign()
      • tanh_shrink()
      • sinc()
    • Normalization
      • batch_normalization()
      • fused_batch_normalization()
      • sync_batch_normalization()
      • mean_subtraction()
      • norm_normalization()
      • clip_by_value()
      • clip_grad_by_value()
      • clip_by_norm()
      • clip_grad_by_norm()
      • layer_normalization()
      • instance_normalization()
      • group_normalization()
      • weight_standardization()
      • weight_normalization()
      • spectral_norm()
    • Reduction
      • sum()
      • mean()
      • max()
      • min()
      • norm()
      • prod()
      • reduce_sum()
      • reduce_mean()
    • Arithmetic
      • add2()
      • add_n()
      • sub2()
      • mul2()
      • mul_n()
      • div2()
      • pow2()
      • add_scalar()
      • mul_scalar()
      • pow_scalar()
      • r_sub_scalar()
      • r_div_scalar()
      • r_pow_scalar()
    • Logical
      • equal()
      • equal_scalar()
      • greater()
      • greater_equal()
      • greater_equal_scalar()
      • greater_scalar()
      • less()
      • less_equal()
      • less_equal_scalar()
      • less_scalar()
      • logical_and()
      • logical_and_scalar()
      • logical_not()
      • logical_or()
      • logical_or_scalar()
      • logical_xor()
      • logical_xor_scalar()
      • not_equal()
      • not_equal_scalar()
      • sign()
      • minimum2()
      • maximum2()
      • minimum_scalar()
      • maximum_scalar()
      • isnan()
      • isinf()
      • reset_nan()
      • reset_inf()
      • where()
    • Math
      • constant()
      • arange()
      • abs()
      • exp()
      • log()
      • round()
      • ceil()
      • floor()
      • identity()
      • matrix_diag()
      • matrix_diag_part()
      • batch_matmul()
      • sin()
      • cos()
      • tan()
      • sinh()
      • cosh()
      • tanh()
      • asin()
      • acos()
      • atan()
      • atan2()
      • asinh()
      • acosh()
      • atanh()
      • cumsum()
      • cumprod()
      • batch_inv()
      • batch_det()
      • batch_logdet()
      • batch_cholesky()
      • erf()
    • Array Manipulation
      • concatenate()
      • split()
      • stack()
      • slice()
      • gather()
      • gather_nd()
      • scatter_nd()
      • scatter_add()
      • pad()
      • transpose()
      • broadcast()
      • broadcast_to()
      • tile()
      • meshgrid()
      • flip()
      • shift()
      • sort()
      • shape()
      • reshape()
      • one_hot()
      • assign()
      • top_k_data()
      • top_k_grad()
      • pack_padded_sequence()
      • pad_packed_sequence()
      • searchsorted()
      • bool_gather()
      • bool_scatter()
      • bool_fill()
      • dot()
    • Stochasticity
      • rand()
      • randint()
      • randn()
      • rand_binomial()
      • rand_beta()
      • rand_gamma()
      • dropout()
      • random_choice()
      • random_crop()
      • random_erase()
      • random_flip()
      • random_shift()
      • image_augmentation()
    • Loss Functions
      • sigmoid_cross_entropy()
      • binary_cross_entropy()
      • softmax_cross_entropy()
      • categorical_cross_entropy()
      • squared_error()
      • absolute_error()
      • huber_loss()
      • epsilon_insensitive_loss()
      • kl_multinomial()
    • Signal Processing
      • interpolate()
      • fft()
      • ifft()
      • stft()
      • istft()
    • Geometric Neural Network Layers
      • affine_grid()
      • warp_by_grid()
      • warp_by_flow()
    • Quantized Neural Network Layers
      • binary_sigmoid()
      • binary_tanh()
      • binary_connect_affine()
      • binary_connect_convolution()
      • binary_weight_affine()
      • binary_weight_convolution()
      • fixed_point_quantize()
      • min_max_quantize()
      • pow2_quantize()
      • prune()
      • inq_affine()
      • inq_convolution()
    • Unsupported, Special Use
      • vat_noise()
      • unlink()
      • sink()
      • confusion_matrix()
    • Image Object Detection
      • nms_detection2d()
    • Validation
      • top_n_error()
      • binary_error()
• Parametric Functions
  • Parameter Management API
    • parameter_scope()
    • get_current_parameter_scope()
    • get_parameters()
    • clear_parameters()
    • save_parameters()
    • load_parameters()
    • get_parameter_or_create()
  • List of Parametric Functions
    • parametric_function_api()
    • affine()
    • convolution()
    • depthwise_convolution()
    • deconvolution()
    • depthwise_deconvolution()
    • deformable_convolution()
    • batch_normalization()
    • fused_batch_normalization()
    • sync_batch_normalization()
    • mean_subtraction()
    • layer_normalization()
    • instance_normalization()
    • group_normalization()
    • rnn()
    • lstm()
    • gru()
    • embed()
    • prelu()
    • svd_affine()
    • svd_convolution()
    • cpd3_convolution()
    • binary_connect_affine()
    • binary_connect_convolution()
    • binary_weight_affine()
    • binary_weight_convolution()
    • inq_affine()
    • inq_convolution()
    • fixed_point_quantized_affine()
    • fixed_point_quantized_convolution()
    • min_max_quantized_affine()
    • min_max_quantized_convolution()
    • pow2_quantized_affine()
    • pow2_quantized_convolution()
    • pruned_affine()
    • pruned_convolution()
    • min_max_quantize()
    • lstm_cell()
    • LSTMCell
      • LSTMCell.__call__()
    • spectral_norm()
    • weight_normalization()
    • multi_head_attention()
    • transformer()
    • transformer_encode()
    • transformer_decode()
  • Parameter Initializer
    • BaseInitializer
      • BaseInitializer.__call__()
    • ConstantInitializer
    • NormalInitializer
    • UniformInitializer
    • UniformIntInitializer
    • RangeInitializer
    • OrthogonalInitializer
    • WeightNormalizationScaleInitializer
    • calc_normal_std_he_forward()
    • calc_normal_std_he_backward()
    • calc_normal_std_glorot()
    • calc_uniform_lim_glorot()
• Grad
  • grad()
  • register()
  • show_registry()
• Solvers
  • Solver
    • Solver
      • Solver.check_inf_grad()
      • Solver.check_inf_or_nan_grad()
      • Solver.check_nan_grad()
      • Solver.clear_parameters()
      • Solver.clip_grad_by_norm()
      • Solver.get_parameters()
      • Solver.get_states()
      • Solver.info
      • Solver.learning_rate()
      • Solver.load_states()
      • Solver.name
      • Solver.remove_parameters()
      • Solver.save_states()
      • Solver.scale_grad()
      • Solver.set_learning_rate()
      • Solver.set_parameters()
      • Solver.set_states()
      • Solver.set_states_from_protobuf()
      • Solver.set_states_to_protobuf()
      • Solver.setup()
      • Solver.update()
      • Solver.weight_decay()
      • Solver.weight_decay_is_fused()
      • Solver.zero_grad()
  • List of solvers
    • Sgd()
    • Momentum()
    • Lars()
    • Nesterov()
    • Adadelta()
    • Adagrad()
    • AdaBelief()
    • RMSprop()
    • RMSpropGraves()
    • Adam()
    • AdaBound()
    • Adamax()
    • AMSGRAD()
    • AMSBound()
    • AdamW()
    • SgdW()
    • Lamb()
• Callbacks
  • Function callback
    • set_function_pre_hook()
    • set_function_post_hook()
    • unset_function_pre_hook()
    • unset_function_post_hook()
  • Solver callback
    • set_solver_pre_hook()
    • set_solver_post_hook()
    • unset_solver_pre_hook()
    • unset_solver_post_hook()
• Communicator
  • Communicator interface
    • Communicator
      • Communicator.abort()
      • Communicator.add_context_and_parameters()
      • Communicator.all_gather()
      • Communicator.all_reduce()
      • Communicator.all_reduce_callback()
      • Communicator.allreduce()
      • Communicator.barrier()
      • Communicator.bcast()
      • Communicator.clear_context_parameters()
      • Communicator.find_group()
      • Communicator.init()
      • Communicator.list_groups()
      • Communicator.local_rank
      • Communicator.name
      • Communicator.new_group()
      • Communicator.rank
      • Communicator.reduce()
      • Communicator.reduce_scatter()
      • Communicator.size
  • List of communicators
    • MultiProcessDataParalellCommunicator()
• Monitors
  • Monitor
  • List of Monitors
    • MonitorSeries
      • MonitorSeries.add()
    • MonitorTimeElapsed
      • MonitorTimeElapsed.add()
    • MonitorImage
      • MonitorImage.add()
    • MonitorImageTile
      • MonitorImageTile.add()
  • Utility functions
    • tile_images()
    • plot_series()
    • plot_time_elapsed()
• Utils
  • NNP save and load utilities
    • save()
    • NnpLoader
      • NnpLoader.get_network()
      • NnpLoader.get_network_names()
    • NnpNetwork
      • NnpNetwork.variables
      • NnpNetwork.inputs
      • NnpNetwork.outputs
  • Image Utils
    • imread()
    • imsave()
    • imresize()
  • Data Iterators
    • DataSource
      • DataSource
        • DataSource.apply_order()
        • DataSource.position
        • DataSource.shuffle
        • DataSource.variables
      • DataSourceWithFileCache
        • DataSourceWithFileCache.apply_order()
        • DataSourceWithFileCache.position
        • DataSourceWithFileCache.shuffle
        • DataSourceWithFileCache.variables
      • DataSourceWithMemoryCache
        • DataSourceWithMemoryCache.apply_order()
        • DataSourceWithMemoryCache.position
        • DataSourceWithMemoryCache.shuffle
        • DataSourceWithMemoryCache.variables
    • DataIterator
      • DataIterator
        • DataIterator.batch_size
        • DataIterator.epoch
        • DataIterator.next()
        • DataIterator.position
        • DataIterator.register_epoch_begin_callback()
        • DataIterator.register_epoch_end_callback()
        • DataIterator.size
        • DataIterator.slice()
        • DataIterator.variables
    • Utilities
      • data_iterator()
      • data_iterator_simple()
      • data_iterator_csv_dataset()
      • data_iterator_cache()
      • data_iterator_concat_datasets()
  • Debug Utils
    • Graph Profiler
      • GraphProfiler
        • GraphProfiler.run()
      • GraphProfilerCsvWriter
        • GraphProfilerCsvWriter.write()
    • Time Profiler
      • TimeProfiler
        • TimeProfiler.calc_elapsed_time()
        • TimeProfiler.post_hook
        • TimeProfiler.pre_hook
        • TimeProfiler.scope()
        • TimeProfiler.to_csv()
    • Nan/Inf Tracer
      • NanInfTracer
        • NanInfTracer.backward_post_hook
        • NanInfTracer.check()
        • NanInfTracer.forward_post_hook
        • NanInfTracer.trace()
    • Pretty Printer
      • PrettyPrinter
        • PrettyPrinter.functions
      • pprint()
  • DLPack
    • from_dlpack()
    • to_dlpack()
  • RNN Utils
    • PackedSequence
    • pad_sequence()
    • pack_padded_sequence()
    • pack_sequence()
    • pad_packed_sequence()
  • Misc
    • Python function profiler utilities
      • profile()
      • FunctionProfile
        • FunctionProfile.print_stats()
        • FunctionProfile.reset_stats()
  • Quantization Aware Training
    • QATConfig
      • QATConfig
        • QATConfig.RecorderPosition
          • QATConfig.RecorderPosition.BEFORE
          • QATConfig.RecorderPosition.BOTH
        • QATConfig.RoundingMethod
          • QATConfig.RoundingMethod.CEIL
          • QATConfig.RoundingMethod.FLOOR
          • QATConfig.RoundingMethod.NOTROUND
          • QATConfig.RoundingMethod.ROUND
        • QATConfig.bn_folding
        • QATConfig.bn_self_folding
        • QATConfig.channel_last
        • QATConfig.channel_wise
        • QATConfig.dtype
        • QATConfig.ext_name
        • QATConfig.learning_rate_scale
        • QATConfig.narrow_range
        • QATConfig.niter_to_recording
        • QATConfig.niter_to_training
        • QATConfig.pow2
        • QATConfig.record_layers
        • QATConfig.recorder_activation
        • QATConfig.recorder_position
        • QATConfig.recorder_weight
        • QATConfig.round_mode
        • QATConfig.skip_bias
        • QATConfig.skip_inputs_layers
        • QATConfig.skip_outputs_layers
        • QATConfig.zero_point
    • QATTensorRTConfig
      • QATTensorRTConfig
        • QATTensorRTConfig.bn_folding
        • QATTensorRTConfig.bn_self_folding
        • QATTensorRTConfig.pow2
        • QATTensorRTConfig.record_layers
    • QATScheduler
      • QATScheduler
        • QATScheduler.save()
        • QATScheduler.step()
• Extensions
  • Utilities for extension
    • list_extensions()
    • import_extension_module()
    • get_extension_context()
  • APIs of extension modules
    • context()
    • device_synchronize()
• Pretrained Models
  • ImageNet Models
    • Common interfaces
      • ImageNetBase
        • ImageNetBase.__call__()
        • ImageNetBase.category_names
        • ImageNetBase.input_shape
    • List of models
      • ResNet18
      • ResNet34
      • ResNet50
      • ResNet101
      • ResNet152
      • ResNet
      • MobileNet
      • MobileNetV2
      • SENet
      • SqueezeNetV10
      • SqueezeNetV11
      • SqueezeNet
      • VGG11
      • VGG13
      • VGG16
      • VGG
      • NIN
      • DenseNet
      • InceptionV3
      • Xception
      • GoogLeNet
      • ResNeXt50
      • ResNeXt101
      • ResNeXt
      • ShuffleNet10
      • ShuffleNet05
      • ShuffleNet20
      • ShuffleNet
  • Object Detection Models
    • Common interfaces
      • ObjectDetection
        • ObjectDetection.__call__()
        • ObjectDetection.input_shape
      • LetterBoxTransform
        • LetterBoxTransform.inverse_coordinate_transform()
      • draw_bounding_boxes()
    • List of models
      • YoloV2
  • Semantic Segmentation Models
    • Common interfaces
      • SemanticSegmentation
        • SemanticSegmentation.__call__()
        • SemanticSegmentation.input_shape
    • List of models
      • DeepLabV3plus
• Out-of-core execution
  • SwapInOutScheduler
    • SwapInOutScheduler
      • SwapInOutScheduler.end_scheduling()
      • SwapInOutScheduler.function_post_hook()
      • SwapInOutScheduler.function_pre_hook()
      • SwapInOutScheduler.start_scheduling()
      • SwapInOutScheduler.update_post_hook()
      • SwapInOutScheduler.update_pre_hook()
• Modules
  • Module
    • Module
      • Module.call()
      • Module.get_parameters()
      • Module.load_parameters()
      • Module.parameter_scope
      • Module.save_parameters()
      • Module.training
      • Module.zero_grad()
• Graph Definition
  • ProtoGraph
    • ProtoGraph
      • ProtoGraph.as_proto()
      • ProtoGraph.current_context
      • ProtoGraph.default_graph()
      • ProtoGraph.expand_loop_control()
      • ProtoGraph.from_proto()
      • ProtoGraph.get_parameters()
  • ProtoNetwork
    • ProtoNetwork
      • ProtoNetwork.__call__()
      • ProtoNetwork.as_proto()
      • ProtoNetwork.execute_on_proto()
      • ProtoNetwork.expand_loop_control()
      • ProtoNetwork.forward_sequence()
      • ProtoNetwork.promote()
      • ProtoNetwork.save()
  • ProtoVariable
    • ProtoVariable
  • ProtoFunction
    • ProtoFunction
      • ProtoFunction.graph_call()
  • load
    • load()
  • save
    • save()
  • Create Protobuf Representation from Computation Graph
  • create_graph_from_variable
    • create_graph_from_variable()
  • get_default_graph
    • get_default_graph()
  • get_default_graph_by_variable
    • get_default_graph_by_variable()
  • graph
    • graph()
  • reset_default_graph
    • reset_default_graph()
• Sequential
  • Sequential
    • Sequential
• Experimental
  • Viewers
    • SimpleGraph
      • SimpleGraph
        • SimpleGraph.create_graphviz_digraph()
        • SimpleGraph.save()
        • SimpleGraph.view()
  • Show Graph by Tensorboard
    • TBGraphWriter
      • TBGraphWriter
        • TBGraphWriter.from_variable()
  • Graph Converters
    • GraphConverter
      • GraphConverter.convert()
    • FunctionModifier
      • FunctionModifier.finish_up()
      • FunctionModifier.get_parameter_scope()
      • FunctionModifier.modify()
    • Function Modifiers
      • BatchNormalizationFoldingModifier
      • AddBiasModifier
      • BatchNormalizationFoldingModifierInner
      • BatchNormalizationFoldingOppositeModifierInner
      • BatchNormalizationSelfFoldingModifier
      • FusedBatchNormalizationModifier
      • UnfusedBatchNormalizationModifier
      • ChannelLastModifier
      • ChannelFirstModifier
      • RemoveFunctionModifier
      • BatchNormBatchStatModifier
      • TestModeModifier
      • IdentityModifier
      • NoGradModifier
      • PruningModifier
        • PruningModifier.__init__()
      • QuantizeNonQNNToRecordingModifier
      • QuantizeRecordingToTrainingModifier
  • Trainers
  • Mixed Precision Trainings
    • DynamicLossScalingUpdater
      • DynamicLossScalingUpdater
        • DynamicLossScalingUpdater.solver
        • DynamicLossScalingUpdater.loss
        • DynamicLossScalingUpdater.data_feeder
        • DynamicLossScalingUpdater.scale
        • DynamicLossScalingUpdater.scaling_factor
        • DynamicLossScalingUpdater.N
        • DynamicLossScalingUpdater.clear_buffer
        • DynamicLossScalingUpdater.accum_grad
        • DynamicLossScalingUpdater.weight_decay
        • DynamicLossScalingUpdater.comm
        • DynamicLossScalingUpdater.grads
        • DynamicLossScalingUpdater.update()
  • Parametric Function Classes
    • Affine
    • Linear
    • Convolution
    • Conv1d
    • Conv2d
    • Conv3d
    • ConvNd
    • Deconvolution
    • Deconv1d
    • Deconv2d
    • Deconv3d
    • DeconvNd
    • BatchNormalization
    • BatchNorm1d
    • BatchNorm2d
    • BatchNorm3d
    • Embed