Welcome to SuperGradients’s documentation!
Welcome To SuperGradients
- Version 3 is out! Notebooks have been updated!
- Build with SuperGradients
- Quick Installation
- What’s New
- Coming soon
- Table of Content
- Getting Started
- Advanced Features
- Installation Methods
- Implemented Model Architectures
- Documentation
- Contributing
- Citation
- Community
- License
- Deci Platform
Technical Documentation
- Common package
setup_crash_handler()explicit_params_validation()singleton()AWSConnectorDatasetDataInterfaceADNNModelRepositoryDataInterfacesADNNModelRepositoryDataInterfaces.load_all_remote_log_files()ADNNModelRepositoryDataInterfaces.save_all_remote_checkpoint_files()ADNNModelRepositoryDataInterfaces.load_remote_checkpoints_file()ADNNModelRepositoryDataInterfaces.load_remote_logging_files()ADNNModelRepositoryDataInterfaces.save_remote_checkpoints_file()ADNNModelRepositoryDataInterfaces.save_remote_tensorboard_event_files()
S3ConnectorS3Connector.check_key_exists()S3Connector.get_object_by_etag()S3Connector.create_bucket()S3Connector.delete_bucket()S3Connector.get_object_metadata()S3Connector.delete_key()S3Connector.upload_file_from_stream()S3Connector.upload_file()S3Connector.download_key()S3Connector.download_keys_by_prefix()S3Connector.download_file_by_path()S3Connector.empty_folder_content_by_path_prefix()S3Connector.upload_buffer()S3Connector.list_bucket_objects()S3Connector.create_presigned_upload_url()S3Connector.create_presigned_download_url()S3Connector.convert_content_length_to_mb()S3Connector.copy_key()
init_trainer()is_distributed()StrictLoadDeepLearningTaskEvaluationTypeMultiGPUModeUpsampleModeAutoLoggerConfigAutoLoggerConfigConsoleSinkS3ConnectorS3Connector.check_key_exists()S3Connector.get_object_by_etag()S3Connector.create_bucket()S3Connector.delete_bucket()S3Connector.get_object_metadata()S3Connector.delete_key()S3Connector.upload_file_from_stream()S3Connector.upload_file()S3Connector.download_key()S3Connector.download_keys_by_prefix()S3Connector.download_file_by_path()S3Connector.empty_folder_content_by_path_prefix()S3Connector.upload_buffer()S3Connector.list_bucket_objects()S3Connector.create_presigned_upload_url()S3Connector.create_presigned_download_url()S3Connector.convert_content_length_to_mb()S3Connector.copy_key()
DatasetDataInterfaceADNNModelRepositoryDataInterfacesADNNModelRepositoryDataInterfaces.load_all_remote_log_files()ADNNModelRepositoryDataInterfaces.save_all_remote_checkpoint_files()ADNNModelRepositoryDataInterfaces.load_remote_checkpoints_file()ADNNModelRepositoryDataInterfaces.load_remote_logging_files()ADNNModelRepositoryDataInterfaces.save_remote_checkpoints_file()ADNNModelRepositoryDataInterfaces.save_remote_tensorboard_event_files()
StrictLoadDeepLearningTaskEvaluationTypeMultiGPUModeUpsampleModeexplicit_params_validation()singleton()init_trainer()is_distributed()register_model()register_detection_module()register_metric()register_loss()- Module contents
- Training package
- super_gradients.training module
DataAugmentationTrainerTrainer.train()Trainer.predict()Trainer.train_from_config()Trainer.resume_experiment()Trainer.evaluate_from_recipe()Trainer.evaluate_checkpoint()Trainer.train()Trainer.get_arch_paramsTrainer.get_structureTrainer.get_architectureTrainer.set_experiment_name()Trainer.get_moduleTrainer.set_module()Trainer.test()Trainer.evaluate()Trainer.get_netTrainer.set_net()Trainer.set_ckpt_best_name()Trainer.set_ema()
KDTrainerMultiGPUModeStrictLoadEvaluationType
- super_gradients.training.datasets module
DataAugmentationListDatasetDirectoryDataSetSegmentationDataSetPascalVOC2012SegmentationDataSetPascalAUG2012SegmentationDataSetPascalVOCAndAUGUnifiedDatasetCoCoSegmentationDataSetDetectionDatasetCOCODetectionDatasetPascalVOCDetectionDatasetImageNetDatasetCifar10Cifar100SuperviselyPersonsDataset
- super_gradients.training.dataloaders module
coco2017_train()coco2017_val()coco2017_train_yolox()coco2017_val_yolox()coco2017_train_ssd_lite_mobilenet_v2()coco2017_val_ssd_lite_mobilenet_v2()imagenet_train()imagenet_val()imagenet_efficientnet_train()imagenet_efficientnet_val()imagenet_mobilenetv2_train()imagenet_mobilenetv2_val()imagenet_mobilenetv3_train()imagenet_mobilenetv3_val()imagenet_regnetY_train()imagenet_regnetY_val()imagenet_resnet50_train()imagenet_resnet50_val()imagenet_resnet50_kd_train()imagenet_resnet50_kd_val()imagenet_vit_base_train()imagenet_vit_base_val()tiny_imagenet_train()tiny_imagenet_val()cifar10_train()cifar10_val()cifar100_train()cifar100_val()cityscapes_train()cityscapes_val()cityscapes_stdc_seg50_train()cityscapes_stdc_seg50_val()cityscapes_stdc_seg75_train()cityscapes_stdc_seg75_val()cityscapes_regseg48_train()cityscapes_regseg48_val()cityscapes_ddrnet_train()cityscapes_ddrnet_val()coco_segmentation_train()coco_segmentation_val()pascal_aug_segmentation_train()pascal_aug_segmentation_val()pascal_voc_segmentation_train()pascal_voc_segmentation_val()supervisely_persons_train()supervisely_persons_val()pascal_voc_detection_train()pascal_voc_detection_val()get_data_loader()get()
- super_gradients.training.exceptions module
- super_gradients.training.kd_trainer module
- super_gradients.training.legacy module
- super_gradients.training.losses_models module
LossesFocalLossLabelSmoothingCrossEntropyLossShelfNetOHEMLossShelfNetSemanticEncodingLossYoloXDetectionLossYoloXDetectionLoss.stridesYoloXDetectionLoss.num_classesYoloXDetectionLoss.use_l1YoloXDetectionLoss.center_sampling_radiusYoloXDetectionLoss.iou_typeYoloXDetectionLoss.component_namesYoloXDetectionLoss.forward()YoloXDetectionLoss.prepare_predictions()YoloXDetectionLoss.get_l1_target()YoloXDetectionLoss.get_assignments()YoloXDetectionLoss.get_in_boxes_info()YoloXDetectionLoss.dynamic_k_matching()YoloXDetectionLoss.reduction
YoloXFastDetectionLossRSquaredLossSSDLossBCEDiceLossKDLogitsLossDiceCEEdgeLoss
- super_gradients.training.metrics module
Metricsaccuracy()AccuracyTop5ToyTestClassificationMetricDetectionMetricsDetectionMetrics.num_clsDetectionMetrics.post_prediction_callbackDetectionMetrics.normalize_targetsDetectionMetrics.iou_thresholdsDetectionMetrics.recall_thresholdsDetectionMetrics.score_thresholdDetectionMetrics.top_k_predictionsDetectionMetrics.dist_sync_on_stepDetectionMetrics.update()DetectionMetrics.compute()
PreprocessSegmentationMetricsArgsPixelAccuracyIoUDiceBinaryIOUBinaryDiceDetectionMetrics_050DetectionMetrics_075DetectionMetrics_050_095
- super_gradients.training.models module
- super_gradients.training.sg_model module
TrainerTrainer.train()Trainer.predict()Trainer.train_from_config()Trainer.resume_experiment()Trainer.evaluate_from_recipe()Trainer.evaluate_checkpoint()Trainer.train()Trainer.get_arch_paramsTrainer.get_structureTrainer.get_architectureTrainer.set_experiment_name()Trainer.get_moduleTrainer.set_module()Trainer.test()Trainer.evaluate()Trainer.get_netTrainer.set_net()Trainer.set_ckpt_best_name()Trainer.set_ema()
MultiGPUModeStrictLoad
- super_gradients.training.training_hyperparams module
cifar10_resnet_train_params()cityscapes_ddrnet_train_params()cityscapes_regseg48_train_params()cityscapes_stdc_base_train_params()cityscapes_stdc_seg50_train_params()cityscapes_stdc_seg75_train_params()coco2017_ssd_lite_mobilenet_v2_train_params()coco2017_yolox_train_params()coco_segmentation_shelfnet_lw_train_params()imagenet_efficientnet_train_params()imagenet_mobilenetv2_train_params()imagenet_mobilenetv3_base_train_params()imagenet_mobilenetv3_large_train_params()imagenet_mobilenetv3_small_train_params()imagenet_regnetY_train_params()imagenet_repvgg_train_params()imagenet_resnet50_train_params()imagenet_resnet50_kd_train_params()imagenet_vit_base_train_params()imagenet_vit_large_train_params()get()
- super_gradients.training.transforms module
TransformsTransforms.SegRandomFlipTransforms.SegResizeTransforms.SegRescaleTransforms.SegRandomRescaleTransforms.SegRandomRotateTransforms.SegCropImageAndMaskTransforms.SegRandomGaussianBlurTransforms.SegPadShortToCropSizeTransforms.SegColorJitterTransforms.DetectionMosaicTransforms.DetectionRandomAffineTransforms.DetectionMixupTransforms.DetectionHSVTransforms.DetectionHorizontalFlipTransforms.DetectionPaddedRescaleTransforms.DetectionTargetsFormatTransforms.DetectionTargetsFormatTransformTransforms.RandomResizedCropAndInterpolationTransforms.RandAugmentTransformTransforms.LightingTransforms.RandomEraseTransforms.ComposeTransforms.ToTensorTransforms.PILToTensorTransforms.ConvertImageDtypeTransforms.ToPILImageTransforms.NormalizeTransforms.ResizeTransforms.CenterCropTransforms.PadTransforms.LambdaTransforms.RandomApplyTransforms.RandomChoiceTransforms.RandomOrderTransforms.RandomCropTransforms.RandomHorizontalFlipTransforms.RandomVerticalFlipTransforms.RandomResizedCropTransforms.FiveCropTransforms.TenCropTransforms.LinearTransformationTransforms.ColorJitterTransforms.RandomRotationTransforms.RandomAffineTransforms.GrayscaleTransforms.RandomGrayscaleTransforms.RandomPerspectiveTransforms.RandomErasingTransforms.GaussianBlurTransforms.InterpolationModeTransforms.RandomInvertTransforms.RandomPosterizeTransforms.RandomSolarizeTransforms.RandomAdjustSharpnessTransforms.RandomAutocontrastTransforms.RandomEqualize
DetectionMosaicDetectionRandomAffineDetectionRandomAffine.target_sizeDetectionRandomAffine.degreesDetectionRandomAffine.translateDetectionRandomAffine.scalesDetectionRandomAffine.shearDetectionRandomAffine.enableDetectionRandomAffine.filter_box_candidatesDetectionRandomAffine.wh_thrDetectionRandomAffine.ar_thrDetectionRandomAffine.area_thrDetectionRandomAffine.close()
DetectionHSVDetectionPaddedRescaleDetectionTargetsFormatTransform
- super_gradients.training.utils module
- Module contents
- super_gradients.training module