API Documentation

• detectron2.checkpoint
  • Checkpointer
    • Checkpointer.__init__()
    • Checkpointer.add_checkpointable()
    • Checkpointer.save()
    • Checkpointer.load()
    • Checkpointer.has_checkpoint()
    • Checkpointer.get_checkpoint_file()
    • Checkpointer.get_all_checkpoint_files()
    • Checkpointer.resume_or_load()
    • Checkpointer.tag_last_checkpoint()
  • PeriodicCheckpointer
    • PeriodicCheckpointer.checkpointer
    • PeriodicCheckpointer.__init__()
    • PeriodicCheckpointer.step()
    • PeriodicCheckpointer.save()
  • DetectionCheckpointer
    • DetectionCheckpointer.load()
• detectron2.config
  • CfgNode
    • CfgNode.clone()
    • CfgNode.freeze()
    • CfgNode.defrost()
    • CfgNode.is_frozen()
    • CfgNode.load_yaml_with_base()
    • CfgNode.merge_from_list()
    • CfgNode.merge_from_other_cfg()
    • CfgNode.dump()
    • CfgNode.merge_from_file()
  • get_cfg()
  • set_global_cfg()
  • configurable()
  • instantiate()
  • LazyCall
  • LazyConfig
    • LazyConfig.apply_overrides()
    • LazyConfig.load()
    • LazyConfig.load_rel()
    • LazyConfig.save()
    • LazyConfig.to_py()
  • Yaml Config References
• detectron2.data
  • DatasetCatalog
  • DatasetCatalog.register()
  • DatasetCatalog.get()
  • MetadataCatalog
  • MetadataCatalog.get()
  • build_detection_test_loader()
  • build_detection_train_loader()
  • get_detection_dataset_dicts()
  • load_proposals_into_dataset()
  • print_instances_class_histogram()
  • Metadata
    • Metadata.name
    • Metadata.as_dict()
    • Metadata.set()
    • Metadata.get()
  • DatasetFromList
    • DatasetFromList.__init__()
  • MapDataset
    • MapDataset.__init__()
  • ToIterableDataset
    • ToIterableDataset.__init__()
  • DatasetMapper
    • DatasetMapper.__init__()
    • DatasetMapper.from_config()
    • DatasetMapper.__call__()
  • detectron2.data.detection_utils module
    • SizeMismatchError
    • convert_image_to_rgb()
    • check_image_size()
    • transform_proposals()
    • transform_instance_annotations()
    • annotations_to_instances()
    • annotations_to_instances_rotated()
    • build_augmentation()
    • create_keypoint_hflip_indices()
    • filter_empty_instances()
    • read_image()
  • detectron2.data.datasets module
    • load_coco_json()
    • load_sem_seg()
    • register_coco_instances()
    • convert_to_coco_json()
    • register_coco_panoptic()
    • register_coco_panoptic_separated()
    • load_lvis_json()
    • register_lvis_instances()
    • get_lvis_instances_meta()
    • load_voc_instances()
    • register_pascal_voc()
  • detectron2.data.samplers module
    • TrainingSampler
      • TrainingSampler.__init__()
    • RandomSubsetTrainingSampler
      • RandomSubsetTrainingSampler.__init__()
    • InferenceSampler
      • InferenceSampler.__init__()
    • RepeatFactorTrainingSampler
      • RepeatFactorTrainingSampler.__init__()
      • RepeatFactorTrainingSampler.repeat_factors_from_category_frequency()
• detectron2.data.transforms
  • Transform
    • Transform.__repr__()
    • Transform.apply_box()
    • Transform.apply_coords()
    • Transform.apply_image()
    • Transform.apply_polygons()
    • Transform.apply_segmentation()
    • Transform.inverse()
    • Transform.register_type()
  • TransformList
    • TransformList.__add__()
    • TransformList.__iadd__()
    • TransformList.__init__()
    • TransformList.__len__()
    • TransformList.__radd__()
    • TransformList.apply_coords()
    • TransformList.apply_image()
    • TransformList.inverse()
  • BlendTransform
    • BlendTransform.__init__()
    • BlendTransform.apply_coords()
    • BlendTransform.apply_image()
    • BlendTransform.apply_segmentation()
    • BlendTransform.inverse()
  • CropTransform
    • CropTransform.__init__()
    • CropTransform.apply_coords()
    • CropTransform.apply_image()
    • CropTransform.apply_polygons()
    • CropTransform.inverse()
  • PadTransform
    • PadTransform.__init__()
    • PadTransform.apply_coords()
    • PadTransform.apply_image()
    • PadTransform.apply_segmentation()
    • PadTransform.inverse()
  • GridSampleTransform
    • GridSampleTransform.__init__()
    • GridSampleTransform.apply_coords()
    • GridSampleTransform.apply_image()
    • GridSampleTransform.apply_segmentation()
  • HFlipTransform
    • HFlipTransform.apply_coords()
    • HFlipTransform.apply_image()
    • HFlipTransform.apply_rotated_box()
    • HFlipTransform.inverse()
  • VFlipTransform
    • VFlipTransform.apply_coords()
    • VFlipTransform.apply_image()
    • VFlipTransform.inverse()
  • NoOpTransform
    • NoOpTransform.apply_coords()
    • NoOpTransform.apply_image()
    • NoOpTransform.apply_rotated_box()
    • NoOpTransform.inverse()
  • ScaleTransform
    • ScaleTransform.__init__()
    • ScaleTransform.apply_coords()
    • ScaleTransform.apply_image()
    • ScaleTransform.apply_segmentation()
    • ScaleTransform.inverse()
  • ExtentTransform
    • ExtentTransform.__init__()
    • ExtentTransform.apply_coords()
    • ExtentTransform.apply_image()
    • ExtentTransform.apply_segmentation()
  • ResizeTransform
    • ResizeTransform.__init__()
    • ResizeTransform.apply_coords()
    • ResizeTransform.apply_image()
    • ResizeTransform.apply_rotated_box()
    • ResizeTransform.apply_segmentation()
    • ResizeTransform.inverse()
  • RotationTransform
    • RotationTransform.__init__()
    • RotationTransform.apply_coords()
    • RotationTransform.apply_image()
    • RotationTransform.apply_segmentation()
    • RotationTransform.create_rotation_matrix()
    • RotationTransform.inverse()
  • ColorTransform
    • ColorTransform.__init__()
    • ColorTransform.apply_coords()
    • ColorTransform.apply_image()
    • ColorTransform.apply_segmentation()
    • ColorTransform.inverse()
  • PILColorTransform
    • PILColorTransform.__init__()
    • PILColorTransform.apply_image()
  • Augmentation
    • Augmentation.__call__()
    • Augmentation.__repr__()
    • Augmentation.__str__()
    • Augmentation.get_transform()
    • Augmentation.input_args
  • AugmentationList
    • AugmentationList.__init__()
  • AugInput
    • AugInput.__init__()
    • AugInput.transform()
  • FixedSizeCrop
    • FixedSizeCrop.__init__()
    • FixedSizeCrop.get_transform()
  • RandomApply
    • RandomApply.__init__()
    • RandomApply.get_transform()
  • RandomBrightness
    • RandomBrightness.__init__()
    • RandomBrightness.get_transform()
  • RandomContrast
    • RandomContrast.__init__()
    • RandomContrast.get_transform()
  • RandomCrop
    • RandomCrop.__init__()
    • RandomCrop.get_crop_size()
    • RandomCrop.get_transform()
  • RandomExtent
    • RandomExtent.__init__()
    • RandomExtent.get_transform()
  • RandomFlip
    • RandomFlip.__init__()
    • RandomFlip.get_transform()
  • RandomSaturation
    • RandomSaturation.__init__()
    • RandomSaturation.get_transform()
  • RandomLighting
    • RandomLighting.__init__()
    • RandomLighting.get_transform()
  • RandomRotation
    • RandomRotation.__init__()
    • RandomRotation.get_transform()
  • Resize
    • Resize.__init__()
    • Resize.get_transform()
  • ResizeScale
    • ResizeScale.__init__()
    • ResizeScale.get_transform()
  • ResizeShortestEdge
    • ResizeShortestEdge.__init__()
    • ResizeShortestEdge.get_output_shape()
    • ResizeShortestEdge.get_transform()
  • RandomCrop_CategoryAreaConstraint
    • RandomCrop_CategoryAreaConstraint.__init__()
    • RandomCrop_CategoryAreaConstraint.get_transform()
  • RandomResize
    • RandomResize.__init__()
    • RandomResize.get_transform()
  • MinIoURandomCrop
    • MinIoURandomCrop.get_transform()
• detectron2.engine
  • detectron2.engine.defaults module
  • detectron2.engine.hooks module
• detectron2.evaluation
  • CityscapesInstanceEvaluator
    • CityscapesInstanceEvaluator.process()
    • CityscapesInstanceEvaluator.evaluate()
  • CityscapesSemSegEvaluator
    • CityscapesSemSegEvaluator.process()
    • CityscapesSemSegEvaluator.evaluate()
  • COCOEvaluator
    • COCOEvaluator.__init__()
    • COCOEvaluator.reset()
    • COCOEvaluator.process()
    • COCOEvaluator.evaluate()
  • RotatedCOCOEvaluator
    • RotatedCOCOEvaluator.process()
    • RotatedCOCOEvaluator.instances_to_json()
  • DatasetEvaluator
    • DatasetEvaluator.reset()
    • DatasetEvaluator.process()
    • DatasetEvaluator.evaluate()
  • DatasetEvaluators
    • DatasetEvaluators.__init__()
    • DatasetEvaluators.reset()
    • DatasetEvaluators.process()
    • DatasetEvaluators.evaluate()
  • inference_context()
  • inference_on_dataset()
  • LVISEvaluator
    • LVISEvaluator.__init__()
    • LVISEvaluator.reset()
    • LVISEvaluator.process()
    • LVISEvaluator.evaluate()
  • COCOPanopticEvaluator
    • COCOPanopticEvaluator.__init__()
    • COCOPanopticEvaluator.reset()
    • COCOPanopticEvaluator.process()
    • COCOPanopticEvaluator.evaluate()
  • PascalVOCDetectionEvaluator
    • PascalVOCDetectionEvaluator.__init__()
    • PascalVOCDetectionEvaluator.reset()
    • PascalVOCDetectionEvaluator.process()
    • PascalVOCDetectionEvaluator.evaluate()
  • SemSegEvaluator
    • SemSegEvaluator.__init__()
    • SemSegEvaluator.reset()
    • SemSegEvaluator.process()
    • SemSegEvaluator.evaluate()
    • SemSegEvaluator.encode_json_sem_seg()
  • print_csv_format()
  • verify_results()
• detectron2.layers
  • FrozenBatchNorm2d
    • FrozenBatchNorm2d.forward()
    • FrozenBatchNorm2d.convert_frozen_batchnorm()
    • FrozenBatchNorm2d.convert_frozenbatchnorm2d_to_batchnorm2d()
    • FrozenBatchNorm2d.training
  • get_norm()
  • NaiveSyncBatchNorm
    • NaiveSyncBatchNorm.forward()
    • NaiveSyncBatchNorm.num_features
    • NaiveSyncBatchNorm.eps
    • NaiveSyncBatchNorm.momentum
    • NaiveSyncBatchNorm.affine
    • NaiveSyncBatchNorm.track_running_stats
  • CycleBatchNormList
    • CycleBatchNormList.__init__()
    • CycleBatchNormList.forward()
    • CycleBatchNormList.extra_repr()
    • CycleBatchNormList.training
  • DeformConv
    • DeformConv.__init__()
    • DeformConv.forward()
    • DeformConv.extra_repr()
    • DeformConv.training
  • ModulatedDeformConv
    • ModulatedDeformConv.__init__()
    • ModulatedDeformConv.forward()
    • ModulatedDeformConv.extra_repr()
    • ModulatedDeformConv.training
  • paste_masks_in_image()
  • nms()
  • batched_nms()
  • batched_nms_rotated()
  • nms_rotated()
  • roi_align()
  • ROIAlign
    • ROIAlign.__init__()
    • ROIAlign.forward()
    • ROIAlign.training
  • roi_align_rotated()
  • ROIAlignRotated
    • ROIAlignRotated.__init__()
    • ROIAlignRotated.forward()
    • ROIAlignRotated.training
  • ShapeSpec
    • ShapeSpec.channels
    • ShapeSpec.height
    • ShapeSpec.width
    • ShapeSpec.stride
  • BatchNorm2d
    • BatchNorm2d.num_features
    • BatchNorm2d.eps
    • BatchNorm2d.momentum
    • BatchNorm2d.affine
    • BatchNorm2d.track_running_stats
  • Conv2d
    • Conv2d.__init__()
    • Conv2d.forward()
    • Conv2d.bias
    • Conv2d.out_channels
    • Conv2d.kernel_size
    • Conv2d.stride
    • Conv2d.padding
    • Conv2d.dilation
    • Conv2d.transposed
    • Conv2d.output_padding
    • Conv2d.groups
    • Conv2d.padding_mode
    • Conv2d.weight
  • ConvTranspose2d
    • ConvTranspose2d.weight
    • ConvTranspose2d.bias
    • ConvTranspose2d.forward()
    • ConvTranspose2d.bias
    • ConvTranspose2d.out_channels
    • ConvTranspose2d.kernel_size
    • ConvTranspose2d.stride
    • ConvTranspose2d.padding
    • ConvTranspose2d.dilation
    • ConvTranspose2d.transposed
    • ConvTranspose2d.output_padding
    • ConvTranspose2d.groups
    • ConvTranspose2d.padding_mode
    • ConvTranspose2d.weight
  • cat()
  • interpolate()
  • Linear
    • Linear.weight
    • Linear.bias
    • Linear.extra_repr()
    • Linear.forward()
    • Linear.reset_parameters()
    • Linear.in_features
    • Linear.out_features
    • Linear.weight
  • nonzero_tuple()
  • cross_entropy()
  • empty_input_loss_func_wrapper()
  • shapes_to_tensor()
  • move_device_like()
  • CNNBlockBase
    • CNNBlockBase.__init__()
    • CNNBlockBase.freeze()
    • CNNBlockBase.training
  • DepthwiseSeparableConv2d
    • DepthwiseSeparableConv2d.__init__()
    • DepthwiseSeparableConv2d.forward()
    • DepthwiseSeparableConv2d.training
  • ASPP
    • ASPP.__init__()
    • ASPP.forward()
    • ASPP.training
  • ciou_loss()
  • diou_loss()
• detectron2.model_zoo
• detectron2.modeling
  • detectron2.modeling.poolers module
  • detectron2.modeling.sampling module
  • detectron2.modeling.box_regression module
  • Model Registries
• detectron2.solver
  • build_lr_scheduler()
  • build_optimizer()
  • get_default_optimizer_params()
  • LRMultiplier
    • LRMultiplier.__init__()
    • LRMultiplier.state_dict()
    • LRMultiplier.get_lr()
  • LRScheduler
  • WarmupParamScheduler
    • WarmupParamScheduler.__init__()
• detectron2.structures
  • Boxes
    • Boxes.tensor
    • Boxes.__getitem__()
    • Boxes.__init__()
    • Boxes.__iter__()
    • Boxes.area()
    • Boxes.cat()
    • Boxes.clip()
    • Boxes.clone()
    • Boxes.device
    • Boxes.get_centers()
    • Boxes.inside_box()
    • Boxes.nonempty()
    • Boxes.scale()
    • Boxes.to()
  • BoxMode
    • BoxMode.XYXY_ABS
    • BoxMode.XYWH_ABS
    • BoxMode.XYXY_REL
    • BoxMode.XYWH_REL
    • BoxMode.XYWHA_ABS
    • BoxMode.convert()
  • pairwise_iou()
  • pairwise_ioa()
  • pairwise_point_box_distance()
  • ImageList
    • ImageList.image_sizes
    • ImageList.__getitem__()
    • ImageList.__init__()
    • ImageList.device
    • ImageList.from_tensors()
    • ImageList.to()
  • Instances
    • Instances.__getitem__()
    • Instances.__init__()
    • Instances.cat()
    • Instances.get()
    • Instances.get_fields()
    • Instances.has()
    • Instances.image_size
    • Instances.remove()
    • Instances.set()
    • Instances.to()
  • Keypoints
    • Keypoints.__getitem__()
    • Keypoints.__init__()
    • Keypoints.cat()
    • Keypoints.device
    • Keypoints.to()
    • Keypoints.to_heatmap()
  • heatmaps_to_keypoints()
  • BitMasks
    • BitMasks.tensor
    • BitMasks.__getitem__()
    • BitMasks.__init__()
    • BitMasks.cat()
    • BitMasks.crop_and_resize()
    • BitMasks.device
    • BitMasks.from_polygon_masks()
    • BitMasks.from_roi_masks()
    • BitMasks.get_bounding_boxes()
    • BitMasks.nonempty()
    • BitMasks.to()
  • PolygonMasks
    • PolygonMasks.polygons
    • PolygonMasks.__getitem__()
    • PolygonMasks.__init__()
    • PolygonMasks.__iter__()
    • PolygonMasks.area()
    • PolygonMasks.cat()
    • PolygonMasks.crop_and_resize()
    • PolygonMasks.device
    • PolygonMasks.get_bounding_boxes()
    • PolygonMasks.nonempty()
    • PolygonMasks.to()
  • polygons_to_bitmask()
  • ROIMasks
    • ROIMasks.__getitem__()
    • ROIMasks.__init__()
    • ROIMasks.device
    • ROIMasks.to()
    • ROIMasks.to_bitmasks()
  • RotatedBoxes
    • RotatedBoxes.__getitem__()
    • RotatedBoxes.__init__()
    • RotatedBoxes.__iter__()
    • RotatedBoxes.area()
    • RotatedBoxes.cat()
    • RotatedBoxes.clip()
    • RotatedBoxes.clone()
    • RotatedBoxes.device
    • RotatedBoxes.get_centers()
    • RotatedBoxes.inside_box()
    • RotatedBoxes.nonempty()
    • RotatedBoxes.normalize_angles()
    • RotatedBoxes.scale()
    • RotatedBoxes.to()
  • pairwise_iou_rotated()
• detectron2.utils
  • detectron2.utils.colormap module
    • colormap()
    • random_color()
    • random_colors()
  • detectron2.utils.comm module
    • get_world_size()
    • get_rank()
    • create_local_process_group()
    • get_local_process_group()
    • get_local_rank()
    • get_local_size()
    • is_main_process()
    • synchronize()
    • all_gather()
    • gather()
    • shared_random_seed()
    • reduce_dict()
  • detectron2.utils.events module
  • detectron2.utils.logger module
    • setup_logger()
    • log_first_n()
    • log_every_n()
    • log_every_n_seconds()
  • detectron2.utils.registry module
    • Registry
      • Registry.__init__()
      • Registry.register()
      • Registry.get()
    • locate()
  • detectron2.utils.memory module
    • retry_if_cuda_oom()
  • detectron2.utils.analysis module
  • detectron2.utils.visualizer module
    • ColorMode
      • ColorMode.IMAGE
      • ColorMode.SEGMENTATION
      • ColorMode.IMAGE_BW
    • VisImage
      • VisImage.__init__()
      • VisImage.reset_image()
      • VisImage.save()
      • VisImage.get_image()
    • Visualizer
      • Visualizer.__init__()
      • Visualizer.draw_instance_predictions()
      • Visualizer.draw_sem_seg()
      • Visualizer.draw_panoptic_seg()
      • Visualizer.draw_dataset_dict()
      • Visualizer.overlay_instances()
      • Visualizer.overlay_rotated_instances()
      • Visualizer.draw_and_connect_keypoints()
      • Visualizer.draw_text()
      • Visualizer.draw_box()
      • Visualizer.draw_rotated_box_with_label()
      • Visualizer.draw_circle()
      • Visualizer.draw_line()
      • Visualizer.draw_binary_mask()
      • Visualizer.draw_soft_mask()
      • Visualizer.draw_polygon()
      • Visualizer.get_output()
  • detectron2.utils.video_visualizer module
    • VideoVisualizer
      • VideoVisualizer.__init__()
      • VideoVisualizer.draw_instance_predictions()
      • VideoVisualizer.draw_sem_seg()
• detectron2.export
• fvcore documentation
  • fvcore.nn
    • activation_count()
    • ActivationCountAnalysis
      • ActivationCountAnalysis.__init__()
      • ActivationCountAnalysis.ancestor_mode()
      • ActivationCountAnalysis.by_module()
      • ActivationCountAnalysis.by_module_and_operator()
      • ActivationCountAnalysis.by_operator()
      • ActivationCountAnalysis.canonical_module_name()
      • ActivationCountAnalysis.clear_op_handles()
      • ActivationCountAnalysis.copy()
      • ActivationCountAnalysis.set_op_handle()
      • ActivationCountAnalysis.total()
      • ActivationCountAnalysis.tracer_warnings()
      • ActivationCountAnalysis.uncalled_modules()
      • ActivationCountAnalysis.uncalled_modules_warnings()
      • ActivationCountAnalysis.unsupported_ops()
      • ActivationCountAnalysis.unsupported_ops_warnings()
    • flop_count()
    • FlopCountAnalysis
      • FlopCountAnalysis.__init__()
      • FlopCountAnalysis.ancestor_mode()
      • FlopCountAnalysis.by_module()
      • FlopCountAnalysis.by_module_and_operator()
      • FlopCountAnalysis.by_operator()
      • FlopCountAnalysis.canonical_module_name()
      • FlopCountAnalysis.clear_op_handles()
      • FlopCountAnalysis.copy()
      • FlopCountAnalysis.set_op_handle()
      • FlopCountAnalysis.total()
      • FlopCountAnalysis.tracer_warnings()
      • FlopCountAnalysis.uncalled_modules()
      • FlopCountAnalysis.uncalled_modules_warnings()
      • FlopCountAnalysis.unsupported_ops()
      • FlopCountAnalysis.unsupported_ops_warnings()
    • sigmoid_focal_loss()
    • sigmoid_focal_loss_star()
    • giou_loss()
    • parameter_count()
    • parameter_count_table()
    • get_bn_modules()
    • update_bn_stats()
    • flop_count_str()
    • flop_count_table()
    • smooth_l1_loss()
    • c2_msra_fill()
    • c2_xavier_fill()
  • fvcore.common
    • Checkpointer
      • Checkpointer.__init__()
      • Checkpointer.add_checkpointable()
      • Checkpointer.save()
      • Checkpointer.load()
      • Checkpointer.has_checkpoint()
      • Checkpointer.get_checkpoint_file()
      • Checkpointer.get_all_checkpoint_files()
      • Checkpointer.resume_or_load()
      • Checkpointer.tag_last_checkpoint()
    • PeriodicCheckpointer
      • PeriodicCheckpointer.checkpointer
      • PeriodicCheckpointer.__init__()
      • PeriodicCheckpointer.step()
      • PeriodicCheckpointer.save()
    • CfgNode
      • CfgNode.load_yaml_with_base()
      • CfgNode.merge_from_file()
      • CfgNode.merge_from_other_cfg()
      • CfgNode.merge_from_list()
    • HistoryBuffer
      • HistoryBuffer.__init__()
      • HistoryBuffer.update()
      • HistoryBuffer.latest()
      • HistoryBuffer.median()
      • HistoryBuffer.avg()
      • HistoryBuffer.global_avg()
      • HistoryBuffer.values()
    • ParamScheduler
      • ParamScheduler.WHERE_EPSILON
      • ParamScheduler.__call__()
    • ConstantParamScheduler
      • ConstantParamScheduler.WHERE_EPSILON
    • CosineParamScheduler
      • CosineParamScheduler.WHERE_EPSILON
    • ExponentialParamScheduler
      • ExponentialParamScheduler.WHERE_EPSILON
    • LinearParamScheduler
      • LinearParamScheduler.WHERE_EPSILON
    • CompositeParamScheduler
      • CompositeParamScheduler.WHERE_EPSILON
    • MultiStepParamScheduler
      • MultiStepParamScheduler.__init__()
      • MultiStepParamScheduler.WHERE_EPSILON
    • StepParamScheduler
      • StepParamScheduler.WHERE_EPSILON
    • StepWithFixedGammaParamScheduler
      • StepWithFixedGammaParamScheduler.WHERE_EPSILON
    • PolynomialDecayParamScheduler
      • PolynomialDecayParamScheduler.WHERE_EPSILON
    • Registry
      • Registry.__init__()
      • Registry.register()
      • Registry.get()
    • Timer
      • Timer.reset()
      • Timer.pause()
      • Timer.is_paused()
      • Timer.resume()
      • Timer.seconds()
      • Timer.avg_seconds()