@@ -1,13 +1,13 @@
 
                             <!DOCTYPE html>
                
 
                             <html class="writer-html5" lang="en" >
                
 
                             <head>
                
 
                            -  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
                
 
                            -
                
 
                            +  <meta charset="utf-8" />
                
 
                               <meta name="viewport" content="width=device-width, initial-scale=1.0" />
                
 
                            -  <title>Common package &mdash; SuperGradients 1.0 documentation</title>
                
 
                            +  <title>Common package &mdash; SuperGradients 3.0.3 documentation</title>
                
 
                                   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
                
 
                                   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
                
 
                                   <link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
                
 
                            +      <link rel="stylesheet" href="_static/custom.css" type="text/css" />
                
 
                               <!--[if lt IE 9]>
                
 
                                 <script src="_static/js/html5shiv.min.js"></script>
                
 
                               <![endif]-->
                
@@ -15,12 +15,14 @@
 
                                     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
                
 
                                     <script src="_static/jquery.js"></script>
                
 
                                     <script src="_static/underscore.js"></script>
                
 
                            +        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
                
 
                                     <script src="_static/doctools.js"></script>
                
 
                            +        <script src="_static/sphinx_highlight.js"></script>
                
 
                                 <script src="_static/js/theme.js"></script>
                
 
                                 <link rel="index" title="Index" href="genindex.html" />
                
 
                                 <link rel="search" title="Search" href="search.html" />
                
 
                                 <link rel="next" title="Training package" href="super_gradients.training.html" />
                
 
                            -    <link rel="prev" title="Fill our 4-question quick survey! We will raffle free SuperGradients swag between those who will participate -&gt; Fill Survey" href="welcome.html" /> 
                
 
                            +    <link rel="prev" title="Version 3 is out! Notebooks have been updated!" href="welcome.html" /> 
                
 
                             </head>
                
 
                             <body class="wy-body-for-nav"> 
                
@@ -38,33 +40,216 @@
 
                               </form>
                
 
                             </div>
                
 
                                     </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
                
 
                            -              <p class="caption"><span class="caption-text">Welcome To SuperGradients</span></p>
                
 
                            +              <p class="caption" role="heading"><span class="caption-text">Welcome To SuperGradients</span></p>
                
 
                             <ul>
                
 
                            -<li class="toctree-l1"><a class="reference internal" href="welcome.html">Fill our 4-question quick survey! We will raffle free SuperGradients swag between those who will participate -&gt; Fill Survey</a></li>
                
 
                            -<li class="toctree-l1"><a class="reference internal" href="welcome.html#supergradients">SuperGradients</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html">Version 3 is out! Notebooks have been updated!</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#build-with-supergradients">Build with SuperGradients</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#quick-installation">Quick Installation</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#what-s-new">What’s New</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#coming-soon">Coming soon</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#table-of-content">Table of Content</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#getting-started">Getting Started</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#advanced-features">Advanced Features</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#installation-methods">Installation Methods</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#implemented-model-architectures">Implemented Model Architectures</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#documentation">Documentation</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#contributing">Contributing</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#citation">Citation</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#community">Community</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#license">License</a></li>
                
 
                            +<li class="toctree-l1"><a class="reference internal" href="welcome.html#deci-platform">Deci Platform</a></li>
                
 
                             </ul>
                
 
                            -<p class="caption"><span class="caption-text">Technical Documentation</span></p>
                
 
                            +<p class="caption" role="heading"><span class="caption-text">Technical Documentation</span></p>
                
 
                             <ul class="current">
                
 
                             <li class="toctree-l1 current"><a class="current reference internal" href="#">Common package</a><ul>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.setup_crash_handler"><code class="docutils literal notranslate"><span class="pre">setup_crash_handler()</span></code></a></li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.explicit_params_validation"><code class="docutils literal notranslate"><span class="pre">explicit_params_validation()</span></code></a></li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.singleton"><code class="docutils literal notranslate"><span class="pre">singleton()</span></code></a></li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.AWSConnector"><code class="docutils literal notranslate"><span class="pre">AWSConnector</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.AWSConnector.get_aws_session"><code class="docutils literal notranslate"><span class="pre">AWSConnector.get_aws_session()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.AWSConnector.get_aws_client_for_service_name"><code class="docutils literal notranslate"><span class="pre">AWSConnector.get_aws_client_for_service_name()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.AWSConnector.get_aws_resource_for_service_name"><code class="docutils literal notranslate"><span class="pre">AWSConnector.get_aws_resource_for_service_name()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.AWSConnector.is_client_error"><code class="docutils literal notranslate"><span class="pre">AWSConnector.is_client_error()</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.DatasetDataInterface"><code class="docutils literal notranslate"><span class="pre">DatasetDataInterface</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.DatasetDataInterface.load_remote_dataset_file"><code class="docutils literal notranslate"><span class="pre">DatasetDataInterface.load_remote_dataset_file()</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.ADNNModelRepositoryDataInterfaces"><code class="docutils literal notranslate"><span class="pre">ADNNModelRepositoryDataInterfaces</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.ADNNModelRepositoryDataInterfaces.load_all_remote_log_files"><code class="docutils literal notranslate"><span class="pre">ADNNModelRepositoryDataInterfaces.load_all_remote_log_files()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.ADNNModelRepositoryDataInterfaces.save_all_remote_checkpoint_files"><code class="docutils literal notranslate"><span class="pre">ADNNModelRepositoryDataInterfaces.save_all_remote_checkpoint_files()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.ADNNModelRepositoryDataInterfaces.load_remote_checkpoints_file"><code class="docutils literal notranslate"><span class="pre">ADNNModelRepositoryDataInterfaces.load_remote_checkpoints_file()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.ADNNModelRepositoryDataInterfaces.load_remote_logging_files"><code class="docutils literal notranslate"><span class="pre">ADNNModelRepositoryDataInterfaces.load_remote_logging_files()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.ADNNModelRepositoryDataInterfaces.save_remote_checkpoints_file"><code class="docutils literal notranslate"><span class="pre">ADNNModelRepositoryDataInterfaces.save_remote_checkpoints_file()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.ADNNModelRepositoryDataInterfaces.save_remote_tensorboard_event_files"><code class="docutils literal notranslate"><span class="pre">ADNNModelRepositoryDataInterfaces.save_remote_tensorboard_event_files()</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.S3Connector"><code class="docutils literal notranslate"><span class="pre">S3Connector</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.check_key_exists"><code class="docutils literal notranslate"><span class="pre">S3Connector.check_key_exists()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.get_object_by_etag"><code class="docutils literal notranslate"><span class="pre">S3Connector.get_object_by_etag()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.create_bucket"><code class="docutils literal notranslate"><span class="pre">S3Connector.create_bucket()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.delete_bucket"><code class="docutils literal notranslate"><span class="pre">S3Connector.delete_bucket()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.get_object_metadata"><code class="docutils literal notranslate"><span class="pre">S3Connector.get_object_metadata()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.delete_key"><code class="docutils literal notranslate"><span class="pre">S3Connector.delete_key()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.upload_file_from_stream"><code class="docutils literal notranslate"><span class="pre">S3Connector.upload_file_from_stream()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.upload_file"><code class="docutils literal notranslate"><span class="pre">S3Connector.upload_file()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.download_key"><code class="docutils literal notranslate"><span class="pre">S3Connector.download_key()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.download_keys_by_prefix"><code class="docutils literal notranslate"><span class="pre">S3Connector.download_keys_by_prefix()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.download_file_by_path"><code class="docutils literal notranslate"><span class="pre">S3Connector.download_file_by_path()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.empty_folder_content_by_path_prefix"><code class="docutils literal notranslate"><span class="pre">S3Connector.empty_folder_content_by_path_prefix()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.upload_buffer"><code class="docutils literal notranslate"><span class="pre">S3Connector.upload_buffer()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.list_bucket_objects"><code class="docutils literal notranslate"><span class="pre">S3Connector.list_bucket_objects()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.create_presigned_upload_url"><code class="docutils literal notranslate"><span class="pre">S3Connector.create_presigned_upload_url()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.create_presigned_download_url"><code class="docutils literal notranslate"><span class="pre">S3Connector.create_presigned_download_url()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.convert_content_length_to_mb"><code class="docutils literal notranslate"><span class="pre">S3Connector.convert_content_length_to_mb()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.S3Connector.copy_key"><code class="docutils literal notranslate"><span class="pre">S3Connector.copy_key()</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.init_trainer"><code class="docutils literal notranslate"><span class="pre">init_trainer()</span></code></a></li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.is_distributed"><code class="docutils literal notranslate"><span class="pre">is_distributed()</span></code></a></li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.StrictLoad"><code class="docutils literal notranslate"><span class="pre">StrictLoad</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.StrictLoad.OFF"><code class="docutils literal notranslate"><span class="pre">StrictLoad.OFF</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.StrictLoad.ON"><code class="docutils literal notranslate"><span class="pre">StrictLoad.ON</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.StrictLoad.NO_KEY_MATCHING"><code class="docutils literal notranslate"><span class="pre">StrictLoad.NO_KEY_MATCHING</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.DeepLearningTask"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.DeepLearningTask.CLASSIFICATION"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask.CLASSIFICATION</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.DeepLearningTask.SEMANTIC_SEGMENTATION"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask.SEMANTIC_SEGMENTATION</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.DeepLearningTask.OBJECT_DETECTION"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask.OBJECT_DETECTION</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.DeepLearningTask.DEPTH_ESTIMATION"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask.DEPTH_ESTIMATION</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.DeepLearningTask.POSE_ESTIMATION"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask.POSE_ESTIMATION</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.DeepLearningTask.NLP"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask.NLP</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.DeepLearningTask.OTHER"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask.OTHER</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.EvaluationType"><code class="docutils literal notranslate"><span class="pre">EvaluationType</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.EvaluationType.TEST"><code class="docutils literal notranslate"><span class="pre">EvaluationType.TEST</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.EvaluationType.VALIDATION"><code class="docutils literal notranslate"><span class="pre">EvaluationType.VALIDATION</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.MultiGPUMode"><code class="docutils literal notranslate"><span class="pre">MultiGPUMode</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.MultiGPUMode.OFF"><code class="docutils literal notranslate"><span class="pre">MultiGPUMode.OFF</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.MultiGPUMode.DATA_PARALLEL"><code class="docutils literal notranslate"><span class="pre">MultiGPUMode.DATA_PARALLEL</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.MultiGPUMode.DISTRIBUTED_DATA_PARALLEL"><code class="docutils literal notranslate"><span class="pre">MultiGPUMode.DISTRIBUTED_DATA_PARALLEL</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.MultiGPUMode.AUTO"><code class="docutils literal notranslate"><span class="pre">MultiGPUMode.AUTO</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.MultiGPUMode.dict"><code class="docutils literal notranslate"><span class="pre">MultiGPUMode.dict()</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.UpsampleMode"><code class="docutils literal notranslate"><span class="pre">UpsampleMode</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.UpsampleMode.NEAREST"><code class="docutils literal notranslate"><span class="pre">UpsampleMode.NEAREST</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.UpsampleMode.BILINEAR"><code class="docutils literal notranslate"><span class="pre">UpsampleMode.BILINEAR</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.UpsampleMode.BICUBIC"><code class="docutils literal notranslate"><span class="pre">UpsampleMode.BICUBIC</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.UpsampleMode.SNPE_BILINEAR"><code class="docutils literal notranslate"><span class="pre">UpsampleMode.SNPE_BILINEAR</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.AutoLoggerConfig"><code class="docutils literal notranslate"><span class="pre">AutoLoggerConfig</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.AutoLoggerConfig.FILE_LOGGING_LEVEL"><code class="docutils literal notranslate"><span class="pre">AutoLoggerConfig.FILE_LOGGING_LEVEL</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.AutoLoggerConfig.CONSOLE_LOGGING_LEVEL"><code class="docutils literal notranslate"><span class="pre">AutoLoggerConfig.CONSOLE_LOGGING_LEVEL</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.AutoLoggerConfig.filename"><code class="docutils literal notranslate"><span class="pre">AutoLoggerConfig.filename</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.AutoLoggerConfig.get_instance"><code class="docutils literal notranslate"><span class="pre">AutoLoggerConfig.get_instance()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.AutoLoggerConfig.get_log_file_path"><code class="docutils literal notranslate"><span class="pre">AutoLoggerConfig.get_log_file_path()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.AutoLoggerConfig.setup_logging"><code class="docutils literal notranslate"><span class="pre">AutoLoggerConfig.setup_logging()</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.auto_logging.AutoLoggerConfig"><code class="docutils literal notranslate"><span class="pre">AutoLoggerConfig</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.auto_logging.AutoLoggerConfig.FILE_LOGGING_LEVEL"><code class="docutils literal notranslate"><span class="pre">AutoLoggerConfig.FILE_LOGGING_LEVEL</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.auto_logging.AutoLoggerConfig.CONSOLE_LOGGING_LEVEL"><code class="docutils literal notranslate"><span class="pre">AutoLoggerConfig.CONSOLE_LOGGING_LEVEL</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.auto_logging.AutoLoggerConfig.filename"><code class="docutils literal notranslate"><span class="pre">AutoLoggerConfig.filename</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.auto_logging.AutoLoggerConfig.get_instance"><code class="docutils literal notranslate"><span class="pre">AutoLoggerConfig.get_instance()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.auto_logging.AutoLoggerConfig.get_log_file_path"><code class="docutils literal notranslate"><span class="pre">AutoLoggerConfig.get_log_file_path()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.auto_logging.AutoLoggerConfig.setup_logging"><code class="docutils literal notranslate"><span class="pre">AutoLoggerConfig.setup_logging()</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.auto_logging.ConsoleSink"><code class="docutils literal notranslate"><span class="pre">ConsoleSink</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.auto_logging.ConsoleSink.set_location"><code class="docutils literal notranslate"><span class="pre">ConsoleSink.set_location()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.auto_logging.ConsoleSink.flush"><code class="docutils literal notranslate"><span class="pre">ConsoleSink.flush()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.auto_logging.ConsoleSink.get_filename"><code class="docutils literal notranslate"><span class="pre">ConsoleSink.get_filename()</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector"><code class="docutils literal notranslate"><span class="pre">S3Connector</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.check_key_exists"><code class="docutils literal notranslate"><span class="pre">S3Connector.check_key_exists()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.get_object_by_etag"><code class="docutils literal notranslate"><span class="pre">S3Connector.get_object_by_etag()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.create_bucket"><code class="docutils literal notranslate"><span class="pre">S3Connector.create_bucket()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.delete_bucket"><code class="docutils literal notranslate"><span class="pre">S3Connector.delete_bucket()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.get_object_metadata"><code class="docutils literal notranslate"><span class="pre">S3Connector.get_object_metadata()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.delete_key"><code class="docutils literal notranslate"><span class="pre">S3Connector.delete_key()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.upload_file_from_stream"><code class="docutils literal notranslate"><span class="pre">S3Connector.upload_file_from_stream()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.upload_file"><code class="docutils literal notranslate"><span class="pre">S3Connector.upload_file()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.download_key"><code class="docutils literal notranslate"><span class="pre">S3Connector.download_key()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.download_keys_by_prefix"><code class="docutils literal notranslate"><span class="pre">S3Connector.download_keys_by_prefix()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.download_file_by_path"><code class="docutils literal notranslate"><span class="pre">S3Connector.download_file_by_path()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.empty_folder_content_by_path_prefix"><code class="docutils literal notranslate"><span class="pre">S3Connector.empty_folder_content_by_path_prefix()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.upload_buffer"><code class="docutils literal notranslate"><span class="pre">S3Connector.upload_buffer()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.list_bucket_objects"><code class="docutils literal notranslate"><span class="pre">S3Connector.list_bucket_objects()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.create_presigned_upload_url"><code class="docutils literal notranslate"><span class="pre">S3Connector.create_presigned_upload_url()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.create_presigned_download_url"><code class="docutils literal notranslate"><span class="pre">S3Connector.create_presigned_download_url()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.convert_content_length_to_mb"><code class="docutils literal notranslate"><span class="pre">S3Connector.convert_content_length_to_mb()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_connection.S3Connector.copy_key"><code class="docutils literal notranslate"><span class="pre">S3Connector.copy_key()</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.data_interface.DatasetDataInterface"><code class="docutils literal notranslate"><span class="pre">DatasetDataInterface</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_interface.DatasetDataInterface.load_remote_dataset_file"><code class="docutils literal notranslate"><span class="pre">DatasetDataInterface.load_remote_dataset_file()</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces"><code class="docutils literal notranslate"><span class="pre">ADNNModelRepositoryDataInterfaces</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.load_all_remote_log_files"><code class="docutils literal notranslate"><span class="pre">ADNNModelRepositoryDataInterfaces.load_all_remote_log_files()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.save_all_remote_checkpoint_files"><code class="docutils literal notranslate"><span class="pre">ADNNModelRepositoryDataInterfaces.save_all_remote_checkpoint_files()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.load_remote_checkpoints_file"><code class="docutils literal notranslate"><span class="pre">ADNNModelRepositoryDataInterfaces.load_remote_checkpoints_file()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.load_remote_logging_files"><code class="docutils literal notranslate"><span class="pre">ADNNModelRepositoryDataInterfaces.load_remote_logging_files()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.save_remote_checkpoints_file"><code class="docutils literal notranslate"><span class="pre">ADNNModelRepositoryDataInterfaces.save_remote_checkpoints_file()</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.save_remote_tensorboard_event_files"><code class="docutils literal notranslate"><span class="pre">ADNNModelRepositoryDataInterfaces.save_remote_tensorboard_event_files()</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.data_types.StrictLoad"><code class="docutils literal notranslate"><span class="pre">StrictLoad</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.StrictLoad.OFF"><code class="docutils literal notranslate"><span class="pre">StrictLoad.OFF</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.StrictLoad.ON"><code class="docutils literal notranslate"><span class="pre">StrictLoad.ON</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.StrictLoad.NO_KEY_MATCHING"><code class="docutils literal notranslate"><span class="pre">StrictLoad.NO_KEY_MATCHING</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.data_types.DeepLearningTask"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.DeepLearningTask.CLASSIFICATION"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask.CLASSIFICATION</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.DeepLearningTask.SEMANTIC_SEGMENTATION"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask.SEMANTIC_SEGMENTATION</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.DeepLearningTask.OBJECT_DETECTION"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask.OBJECT_DETECTION</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.DeepLearningTask.DEPTH_ESTIMATION"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask.DEPTH_ESTIMATION</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.DeepLearningTask.POSE_ESTIMATION"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask.POSE_ESTIMATION</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.DeepLearningTask.NLP"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask.NLP</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.DeepLearningTask.OTHER"><code class="docutils literal notranslate"><span class="pre">DeepLearningTask.OTHER</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.data_types.EvaluationType"><code class="docutils literal notranslate"><span class="pre">EvaluationType</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.EvaluationType.TEST"><code class="docutils literal notranslate"><span class="pre">EvaluationType.TEST</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.EvaluationType.VALIDATION"><code class="docutils literal notranslate"><span class="pre">EvaluationType.VALIDATION</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.data_types.MultiGPUMode"><code class="docutils literal notranslate"><span class="pre">MultiGPUMode</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.MultiGPUMode.OFF"><code class="docutils literal notranslate"><span class="pre">MultiGPUMode.OFF</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.MultiGPUMode.DATA_PARALLEL"><code class="docutils literal notranslate"><span class="pre">MultiGPUMode.DATA_PARALLEL</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.MultiGPUMode.DISTRIBUTED_DATA_PARALLEL"><code class="docutils literal notranslate"><span class="pre">MultiGPUMode.DISTRIBUTED_DATA_PARALLEL</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.MultiGPUMode.AUTO"><code class="docutils literal notranslate"><span class="pre">MultiGPUMode.AUTO</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.MultiGPUMode.dict"><code class="docutils literal notranslate"><span class="pre">MultiGPUMode.dict()</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.data_types.UpsampleMode"><code class="docutils literal notranslate"><span class="pre">UpsampleMode</span></code></a><ul>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.UpsampleMode.NEAREST"><code class="docutils literal notranslate"><span class="pre">UpsampleMode.NEAREST</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.UpsampleMode.BILINEAR"><code class="docutils literal notranslate"><span class="pre">UpsampleMode.BILINEAR</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.UpsampleMode.BICUBIC"><code class="docutils literal notranslate"><span class="pre">UpsampleMode.BICUBIC</span></code></a></li>
                
 
                            +<li class="toctree-l3"><a class="reference internal" href="#super_gradients.common.data_types.UpsampleMode.SNPE_BILINEAR"><code class="docutils literal notranslate"><span class="pre">UpsampleMode.SNPE_BILINEAR</span></code></a></li>
                
 
                            +</ul>
                
 
                            +</li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.decorators.explicit_params_validation"><code class="docutils literal notranslate"><span class="pre">explicit_params_validation()</span></code></a></li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.decorators.singleton"><code class="docutils literal notranslate"><span class="pre">singleton()</span></code></a></li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.environment.init_trainer"><code class="docutils literal notranslate"><span class="pre">init_trainer()</span></code></a></li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.environment.is_distributed"><code class="docutils literal notranslate"><span class="pre">is_distributed()</span></code></a></li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.registry.register_model"><code class="docutils literal notranslate"><span class="pre">register_model()</span></code></a></li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.registry.register_detection_module"><code class="docutils literal notranslate"><span class="pre">register_detection_module()</span></code></a></li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.registry.register_metric"><code class="docutils literal notranslate"><span class="pre">register_metric()</span></code></a></li>
                
 
                            +<li class="toctree-l2"><a class="reference internal" href="#super_gradients.common.registry.register_loss"><code class="docutils literal notranslate"><span class="pre">register_loss()</span></code></a></li>
                
 
                             <li class="toctree-l2"><a class="reference internal" href="#module-contents">Module contents</a></li>
                
 
                             </ul>
                
 
                             </li>
                
 
                             <li class="toctree-l1"><a class="reference internal" href="super_gradients.training.html">Training package</a></li>
                
 
                            -</ul>
                
 
                            -<p class="caption"><span class="caption-text">User Guide</span></p>
                
 
                            -<ul>
                
 
                            -<li class="toctree-l1"><a class="reference internal" href="user_guide.html">What is SuperGradients?</a></li>
                
 
                            -<li class="toctree-l1"><a class="reference internal" href="user_guide.html#introducing-the-supergradients-library">Introducing the SuperGradients library</a></li>
                
 
                            -<li class="toctree-l1"><a class="reference internal" href="user_guide.html#installation">Installation</a></li>
                
 
                            -<li class="toctree-l1"><a class="reference internal" href="user_guide.html#integrating-your-training-code-complete-walkthrough">Integrating Your Training Code - Complete Walkthrough</a></li>
                
 
                            -<li class="toctree-l1"><a class="reference internal" href="user_guide.html#training-parameters">Training Parameters</a></li>
                
 
                            -<li class="toctree-l1"><a class="reference internal" href="user_guide.html#logs-and-checkpoints">Logs and Checkpoints</a></li>
                
 
                            -<li class="toctree-l1"><a class="reference internal" href="user_guide.html#dataset-parameters">Dataset Parameters</a></li>
                
 
                            -<li class="toctree-l1"><a class="reference internal" href="user_guide.html#network-architectures">Network Architectures</a></li>
                
 
                            -<li class="toctree-l1"><a class="reference internal" href="user_guide.html#pretrained-models">Pretrained Models</a></li>
                
 
                            -<li class="toctree-l1"><a class="reference internal" href="user_guide.html#how-to-reproduce-our-training-recipes">How To Reproduce Our Training Recipes</a></li>
                
 
                            -<li class="toctree-l1"><a class="reference internal" href="user_guide.html#professional-tools-integration">Professional Tools Integration</a></li>
                
 
                            -<li class="toctree-l1"><a class="reference internal" href="user_guide.html#supergradients-faq">SuperGradients FAQ</a></li>
                
 
                             </ul>
                
 
                                     </div>
                
@@ -91,9 +276,9 @@
 
                                       <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
                
 
                                        <div itemprop="articleBody">
                
 
                            -  <section id="common-package">
                
 
                            -<h1>Common package<a class="headerlink" href="#common-package" title="Permalink to this headline"></a></h1>
                
 
                            -<table class="longtable docutils align-default">
                
 
                            +  <div class="section" id="common-package">
                
 
                            +<h1>Common package<a class="headerlink" href="#common-package" title="Permalink to this heading"></a></h1>
                
 
                            +<table class="autosummary longtable docutils align-default">
                
 
                             <colgroup>
                
 
                             <col style="width: 10%" />
                
 
                             <col style="width: 90%" />
                
@@ -102,8 +287,14 @@
 
                             </tbody>
                
 
                             </table>
                
 
                             <span class="target" id="module-super_gradients.common"></span><dl class="py function">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.setup_crash_handler">
                
 
                            +<span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">setup_crash_handler</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/crash_handler/crash_handler.html#setup_crash_handler"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.setup_crash
                
 
                            +<dd><p>Setup the environment to handle crashes, with crash tips and more.</p>
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<dl class="py function">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.explicit_params_validation">
                
 
                            -<span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">explicit_params_validation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">function</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span c
                
 
                            +<span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">explicit_params_validation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">function</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span>
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py function">
                
@@ -116,12 +307,12 @@ attribute to access decorated class directly in unit tests</p>
 
                             <dl class="py class">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.AWSConnector">
                
 
                            -<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">AWSConnector</span></span><a class="reference internal" href="_modules/super_gradients/common/aws_connection/aws_connector.html#AWSConnector"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.AWSConnector" title="Permalink 
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">AWSConnector</span></span><a class="reference internal" href="_modules/super_gradients/common/aws_connection/aws_connector.html#AWSConnector"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.AWSConne
                
 
                             <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
                
 
                             <p>AWSConnector - Connects to AWS using Credentials File or IAM Role</p>
                
 
                             <dl class="py method">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.AWSConnector.get_aws_session">
                
 
                            -<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">get_aws_session</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile_name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> &#x2192; <span class="pre">boto3.session.Session</span><a class="reference internal" href="_modules/super_gra
                
 
                            +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_aws_session</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;
                
 
                             <dd><dl class="simple">
                
 
                             <dt>get_aws_session - Connects to AWS to retrieve an AWS Session</dt><dd><dl class="field-list simple">
                
 
                             <dt class="field-odd">param      profile_name</dt>
                
@@ -137,7 +328,7 @@ attribute to access decorated class directly in unit tests</p>
 
                             <dl class="py method">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.AWSConnector.get_aws_client_for_service_name">
                
 
                            -<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">get_aws_client_for_service_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile_name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service_name</span></span><span class="p"><span class="pre">:</span>
                
 
                            +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_aws_client_for_service_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service_name</span></s
                
 
                             <dd><dl class="simple">
                
 
                             <dt>get_aws_client_for_service_name - Connects to AWS to retrieve the relevant Client</dt><dd><dl class="field-list simple">
                
 
                             <dt class="field-odd">param      profile_name</dt>
                
@@ -156,7 +347,7 @@ attribute to access decorated class directly in unit tests</p>
 
                             <dl class="py method">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.AWSConnector.get_aws_resource_for_service_name">
                
 
                            -<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">get_aws_resource_for_service_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile_name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service_name</span></span><span class="p"><span class="pre">:</spa
                
 
                            +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_aws_resource_for_service_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">service_name</span><
                
 
                             <dd><dl class="simple">
                
 
                             <dt>Connects to AWS to retrieve the relevant Resource (More functionality then Client)</dt><dd><dl class="field-list simple">
                
 
                             <dt class="field-odd">param      profile_name</dt>
                
@@ -175,14 +366,14 @@ attribute to access decorated class directly in unit tests</p>
 
                             <dl class="py method">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.AWSConnector.is_client_error">
                
 
                            -<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">is_client_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/aws_connection/aws_connector.html#AWSConnector.is_client_error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="heade
                
 
                            +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_client_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/aws_connection/aws_connector.html#AWSConnector.is_client_error"><span class="viewcode-link"><span class="pre">[source]</span></s
                
 
                             <dd></dd></dl>
                
 
                             </dd></dl>
                
 
                             <dl class="py class">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.DatasetDataInterface">
                
 
                            -<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">DatasetDataInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class=
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">DatasetDataInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em 
                
 
                             <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
                
 
                             <dl class="py method">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.DatasetDataInterface.load_remote_dataset_file">
                
@@ -193,8 +384,8 @@ attribute to access decorated class directly in unit tests</p>
 
                             <dl class="py class">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.ADNNModelRepositoryDataInterfaces">
                
 
                            -<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">ADNNModelRepositoryDataInterfaces</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_connection_location</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span> <span class="o"><span 
                
 
                            -<dd><p>Bases: <a class="reference internal" href="super_gradients.common.abstractions.html#super_gradients.common.abstractions.abstract_logger.ILogger" title="super_gradients.common.abstractions.abstract_logger.ILogger"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.common.abstractions.abstract_logger.ILogger</span></code></a></p>
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">ADNNModelRepositoryDataInterfaces</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_connection_location</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class=
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ILogger</span></code></p>
                
 
                             <p>ResearchModelRepositoryDataInterface</p>
                
 
                             <dl class="py method">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.ADNNModelRepositoryDataInterfaces.load_all_remote_log_files">
                
@@ -230,8 +421,8 @@ attribute to access decorated class directly in unit tests</p>
 
                             <dl class="py class">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.S3Connector">
                
 
                            -<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">S3Connector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buc
                
 
                            -<dd><p>Bases: <a class="reference internal" href="super_gradients.common.abstractions.html#super_gradients.common.abstractions.abstract_logger.ILogger" title="super_gradients.common.abstractions.abstract_logger.ILogger"><code class="xref py py-class docutils literal notranslate"><span class="pre">super_gradients.common.abstractions.abstract_logger.ILogger</span></code></a></p>
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">S3Connector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="si
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ILogger</span></code></p>
                
 
                             <p>S3Connector - S3 Connection Manager</p>
                
 
                             <dl class="py method">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.S3Connector.check_key_exists">
                
@@ -315,7 +506,7 @@ attribute to access decorated class directly in unit tests</p>
 
                             <dl class="py method">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.S3Connector.convert_content_length_to_mb">
                
 
                            -<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">convert_content_length_to_mb</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content_length</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_connection/s3_connector.html#S3Connector.convert_content_length_to_mb"><span class="viewcode-link"><span class="pre">[sourc
                
 
                            +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">convert_content_length_to_mb</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content_length</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_connection/s3_connector.html#S3Connector.convert_content_length_to_mb"><span class="viewcode-link"><
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py method">
                
@@ -328,96 +519,97 @@ attribute to access decorated class directly in unit tests</p>
 
                             <dl class="py function">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.init_trainer">
                
 
                             <span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">init_trainer</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/environment/env_helpers.html#init_trainer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.init_trainer" title="Permalin
                
 
                            -<dd><p>a function to initialize the super_gradients environment. This function should be the first thing to be called
                
 
                            -by any code running super_gradients. It resolves conflicts between the different tools, packages and environments used
                
 
                            -and prepares the super_gradients environment.</p>
                
 
                            +<dd><p>Initialize the super_gradients environment.</p>
                
 
                            +<p>This function should be the first thing to be called by any code running super_gradients.
                
 
                            +It resolves conflicts between the different tools, packages and environments used and prepares the super_gradients environment.</p>
                
 
                             </dd></dl>
                
 
                             <dl class="py function">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.is_distributed">
                
 
                            -<span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">is_distributed</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <span class="pre">bool</span><a class="reference internal" href="_modules/super_gradients/common/environment/env_helpers.html#is_distributed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gra
                
 
                            +<span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">is_distributed</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="_modules/super_gradients/common/environment/env_helpers.html#is_distributed">
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py class">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.StrictLoad">
                
 
                            -<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">StrictLoad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/strict_load.html#StrictLoad"><span class="vie
                
 
                            -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
                
 
                            -<dl>
                
 
                            -<dt>Wrapper for adding more functionality to torch’s strict_load parameter in load_state_dict().</dt><dd><dl>
                
 
                            -<dt>Attributes:</dt><dd><p>OFF              - Native torch “strict_load = off” behaviour. See nn.Module.load_state_dict() documentation for more details.
                
 
                            -ON               - Native torch “strict_load = on” behaviour. See nn.Module.load_state_dict() documentation for more details.
                
 
                            -NO_KEY_MATCHING  - Allows the usage of SuperGradient’s adapt_checkpoint function, which loads a checkpoint by matching each</p>
                
 
                            -<blockquote>
                
 
                            -<div><p>layer’s shapes (and bypasses the strict matching of the names of each layer (ie: disregards the state_dict key matching)).</p>
                
 
                            -</div></blockquote>
                
 
                            -</dd>
                
 
                            -</dl>
                
 
                            -</dd>
                
 
                            -</dl>
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">StrictLoad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/strict_load.html#Stric
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
                
 
                            +<p>Wrapper for adding more functionality to torch’s strict_load parameter in load_state_dict().
                
 
                            +.. attribute:: OFF              - Native torch “strict_load = off” behaviour. See nn.Module.load_state_dict() documentation for more details.</p>
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py">
                
 
                            +<span class="sig-name descname"><span class="pre">ON</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">-</span> <span class="pre">Native</span> <span class="pre">torch</span> <span class="pre">&quot;strict_load</span> <span class="pre">=</span> <span class="pre">on&quot;</span> <span class="pre">behaviour.</span> <span class="pre">See</span> <span class="pre">nn.Module.load_state_dict()</span> <span class="pre">documentation</span> <spa
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py">
                
 
                            +<span class="sig-name descname"><span class="pre">NO_KEY_MATCHING</span>&#160; <span class="pre">-</span> <span class="pre">Allows</span> <span class="pre">the</span> <span class="pre">usage</span> <span class="pre">of</span> <span class="pre">SuperGradient's</span> <span class="pre">adapt_checkpoint</span> <span class="pre">function,</span> <span class="pre">which</span> <span class="pre">loads</span> <span class="pre">a</span> <span class="pre">checkpoint</span> <span class="pre">by</span> <s
                
 
                            +<dd><p>layer’s shapes (and bypasses the strict matching of the names of each layer (ie: disregards the state_dict key matching)).</p>
                
 
                            +</dd></dl>
                
 
                            +
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.StrictLoad.OFF">
                
 
                            -<span class="sig-name descname"><span class="pre">OFF</span></span><em class="property"> <span class="pre">=</span> <span class="pre">False</span></em><a class="headerlink" href="#super_gradients.common.StrictLoad.OFF" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">OFF</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#super_gradients.common.StrictLoad.OFF" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.StrictLoad.ON">
                
 
                            -<span class="sig-name descname"><span class="pre">ON</span></span><em class="property"> <span class="pre">=</span> <span class="pre">True</span></em><a class="headerlink" href="#super_gradients.common.StrictLoad.ON" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">ON</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#super_gradients.common.StrictLoad.ON" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.StrictLoad.NO_KEY_MATCHING">
                
 
                            -<span class="sig-name descname"><span class="pre">NO_KEY_MATCHING</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'no_key_matching'</span></em><a class="headerlink" href="#super_gradients.common.StrictLoad.NO_KEY_MATCHING" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">NO_KEY_MATCHING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'no_key_matching'</span></em><a class="headerlink" href="#super_gradients.common.StrictLoad.NO_KEY_MATCHING" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             </dd></dl>
                
 
                             <dl class="py class">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.DeepLearningTask">
                
 
                            -<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">DeepLearningTask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/deep_learning_task.html#DeepLearningTas
                
 
                            -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">DeepLearningTask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/deep_learning_ta
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
                
 
                             <p>An enumeration.</p>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.DeepLearningTask.CLASSIFICATION">
                
 
                            -<span class="sig-name descname"><span class="pre">CLASSIFICATION</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'classification'</span></em><a class="headerlink" href="#super_gradients.common.DeepLearningTask.CLASSIFICATION" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">CLASSIFICATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'classification'</span></em><a class="headerlink" href="#super_gradients.common.DeepLearningTask.CLASSIFICATION" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.DeepLearningTask.SEMANTIC_SEGMENTATION">
                
 
                            -<span class="sig-name descname"><span class="pre">SEMANTIC_SEGMENTATION</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'semantic_segmentation'</span></em><a class="headerlink" href="#super_gradients.common.DeepLearningTask.SEMANTIC_SEGMENTATION" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">SEMANTIC_SEGMENTATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'semantic_segmentation'</span></em><a class="headerlink" href="#super_gradients.common.DeepLearningTask.SEMANTIC_SEGMENTATION" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.DeepLearningTask.OBJECT_DETECTION">
                
 
                            -<span class="sig-name descname"><span class="pre">OBJECT_DETECTION</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'object_detection'</span></em><a class="headerlink" href="#super_gradients.common.DeepLearningTask.OBJECT_DETECTION" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">OBJECT_DETECTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'object_detection'</span></em><a class="headerlink" href="#super_gradients.common.DeepLearningTask.OBJECT_DETECTION" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.DeepLearningTask.DEPTH_ESTIMATION">
                
 
                            -<span class="sig-name descname"><span class="pre">DEPTH_ESTIMATION</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'depth_estimation'</span></em><a class="headerlink" href="#super_gradients.common.DeepLearningTask.DEPTH_ESTIMATION" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">DEPTH_ESTIMATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'depth_estimation'</span></em><a class="headerlink" href="#super_gradients.common.DeepLearningTask.DEPTH_ESTIMATION" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.DeepLearningTask.POSE_ESTIMATION">
                
 
                            -<span class="sig-name descname"><span class="pre">POSE_ESTIMATION</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'pose_estimation'</span></em><a class="headerlink" href="#super_gradients.common.DeepLearningTask.POSE_ESTIMATION" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">POSE_ESTIMATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pose_estimation'</span></em><a class="headerlink" href="#super_gradients.common.DeepLearningTask.POSE_ESTIMATION" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.DeepLearningTask.NLP">
                
 
                            -<span class="sig-name descname"><span class="pre">NLP</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'nlp'</span></em><a class="headerlink" href="#super_gradients.common.DeepLearningTask.NLP" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">NLP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'nlp'</span></em><a class="headerlink" href="#super_gradients.common.DeepLearningTask.NLP" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.DeepLearningTask.OTHER">
                
 
                            -<span class="sig-name descname"><span class="pre">OTHER</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'other'</span></em><a class="headerlink" href="#super_gradients.common.DeepLearningTask.OTHER" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">OTHER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'other'</span></em><a class="headerlink" href="#super_gradients.common.DeepLearningTask.OTHER" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             </dd></dl>
                
 
                             <dl class="py class">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.EvaluationType">
                
 
                            -<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">EvaluationType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/evaluation_type.html#EvaluationType"><spa
                
 
                            -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
                
 
                            -<p>Passed to SgModel.evaluate(..), and controls which phase callbacks should be triggered (if at all).</p>
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">EvaluationType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/evaluation_type.ht
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
                
 
                            +<p>Passed to Trainer.evaluate(..), and controls which phase callbacks should be triggered (if at all).</p>
                
 
                             <blockquote>
                
 
                             <div><dl class="simple">
                
 
                             <dt>Attributes:</dt><dd><p>TEST
                
@@ -427,20 +619,20 @@ VALIDATION</p>
 
                             </div></blockquote>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.EvaluationType.TEST">
                
 
                            -<span class="sig-name descname"><span class="pre">TEST</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'TEST'</span></em><a class="headerlink" href="#super_gradients.common.EvaluationType.TEST" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">TEST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TEST'</span></em><a class="headerlink" href="#super_gradients.common.EvaluationType.TEST" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.EvaluationType.VALIDATION">
                
 
                            -<span class="sig-name descname"><span class="pre">VALIDATION</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'VALIDATION'</span></em><a class="headerlink" href="#super_gradients.common.EvaluationType.VALIDATION" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">VALIDATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'VALIDATION'</span></em><a class="headerlink" href="#super_gradients.common.EvaluationType.VALIDATION" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             </dd></dl>
                
 
                             <dl class="py class">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.MultiGPUMode">
                
 
                            -<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">MultiGPUMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/multi_gpu_mode.html#MultiGPUMode"><span cla
                
 
                            -<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">MultiGPUMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/multi_gpu_mode.html#
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py">
                
 
                             <span class="sig-name descname"><span class="pre">OFF</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">-</span> <span class="pre">Single</span> <span class="pre">GPU</span> <span class="pre">Mode</span> <span class="pre">/</span> <span class="pre">CPU</span> <span class="pre">Mode</span></span></dt>
                
@@ -458,36 +650,574 @@ VALIDATION</p>
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.MultiGPUMode.OFF">
                
 
                            -<span class="sig-name descname"><span class="pre">OFF</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'Off'</span></em><a class="headerlink" href="#super_gradients.common.MultiGPUMode.OFF" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">OFF</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Off'</span></em><a class="headerlink" href="#super_gradients.common.MultiGPUMode.OFF" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.MultiGPUMode.DATA_PARALLEL">
                
 
                            -<span class="sig-name descname"><span class="pre">DATA_PARALLEL</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'DP'</span></em><a class="headerlink" href="#super_gradients.common.MultiGPUMode.DATA_PARALLEL" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">DATA_PARALLEL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DP'</span></em><a class="headerlink" href="#super_gradients.common.MultiGPUMode.DATA_PARALLEL" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.MultiGPUMode.DISTRIBUTED_DATA_PARALLEL">
                
 
                            -<span class="sig-name descname"><span class="pre">DISTRIBUTED_DATA_PARALLEL</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'DDP'</span></em><a class="headerlink" href="#super_gradients.common.MultiGPUMode.DISTRIBUTED_DATA_PARALLEL" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">DISTRIBUTED_DATA_PARALLEL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DDP'</span></em><a class="headerlink" href="#super_gradients.common.MultiGPUMode.DISTRIBUTED_DATA_PARALLEL" title="Permalink to this definition"></a></dt>
                
 
                             <dd></dd></dl>
                
 
                             <dl class="py attribute">
                
 
                             <dt class="sig sig-object py" id="super_gradients.common.MultiGPUMode.AUTO">
                
 
                            -<span class="sig-name descname"><span class="pre">AUTO</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'AUTO'</span></em><a class="headerlink" href="#super_gradients.common.MultiGPUMode.AUTO" title="Permalink to this definition"></a></dt>
                
 
                            +<span class="sig-name descname"><span class="pre">AUTO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'AUTO'</span></em><a class="headerlink" href="#super_gradients.common.MultiGPUMode.AUTO" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.MultiGPUMode.dict">
                
 
                            +<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/multi_gpu_mode.html#MultiGPUMode.dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.MultiGPUMode.dict" title="Permalin
                
 
                            +<dd><p>return dictionary mapping from the mode name (in call string cases) to the enum value</p>
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<dl class="py class">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.UpsampleMode">
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">UpsampleMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/upsample_mode.html#U
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
                
 
                            +<p>An enumeration.</p>
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.UpsampleMode.NEAREST">
                
 
                            +<span class="sig-name descname"><span class="pre">NEAREST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'nearest'</span></em><a class="headerlink" href="#super_gradients.common.UpsampleMode.NEAREST" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.UpsampleMode.BILINEAR">
                
 
                            +<span class="sig-name descname"><span class="pre">BILINEAR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bilinear'</span></em><a class="headerlink" href="#super_gradients.common.UpsampleMode.BILINEAR" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.UpsampleMode.BICUBIC">
                
 
                            +<span class="sig-name descname"><span class="pre">BICUBIC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bicubic'</span></em><a class="headerlink" href="#super_gradients.common.UpsampleMode.BICUBIC" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.UpsampleMode.SNPE_BILINEAR">
                
 
                            +<span class="sig-name descname"><span class="pre">SNPE_BILINEAR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'snpe_bilinear'</span></em><a class="headerlink" href="#super_gradients.common.UpsampleMode.SNPE_BILINEAR" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<dl class="py class">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.AutoLoggerConfig">
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.</span></span><span class="sig-name descname"><span class="pre">AutoLoggerConfig</span></span><a class="reference internal" href="_modules/super_gradients/common/auto_logging/auto_logger.html#AutoLoggerConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.Auto
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
                
 
                            +<p>A Class for the Automated Logging Config</p>
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.AutoLoggerConfig.FILE_LOGGING_LEVEL">
                
 
                            +<span class="sig-name descname"><span class="pre">FILE_LOGGING_LEVEL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DEBUG'</span></em><a class="headerlink" href="#super_gradients.common.AutoLoggerConfig.FILE_LOGGING_LEVEL" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.AutoLoggerConfig.CONSOLE_LOGGING_LEVEL">
                
 
                            +<span class="sig-name descname"><span class="pre">CONSOLE_LOGGING_LEVEL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'INFO'</span></em><a class="headerlink" href="#super_gradients.common.AutoLoggerConfig.CONSOLE_LOGGING_LEVEL" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.AutoLoggerConfig.filename">
                
 
                            +<span class="sig-name descname"><span class="pre">filename</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#super_gradients.common.AutoLoggerConfig.filename" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.AutoLoggerConfig.get_instance">
                
 
                            +<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_instance</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/auto_logging/auto_logger.html#AutoLoggerConfig.get_instance"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.AutoLoggerConfig.get
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.AutoLoggerConfig.get_log_file_path">
                
 
                            +<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_log_file_path</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/super_gradients/common/auto_logging/auto_logger.html#AutoLoggerConfig.get_l
                
 
                            +<dd><p>Return the current log file used to store log messages
                
 
                            +:return: Full path to log file</p>
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.AutoLoggerConfig.setup_logging">
                
 
                            +<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setup_logging</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy_already_logged_messages</span></sp
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<span class="target" id="module-super_gradients.common.auto_logging"></span><dl class="py class">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.auto_logging.AutoLoggerConfig">
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.auto_logging.</span></span><span class="sig-name descname"><span class="pre">AutoLoggerConfig</span></span><a class="reference internal" href="_modules/super_gradients/common/auto_logging/auto_logger.html#AutoLoggerConfig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradient
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
                
 
                            +<p>A Class for the Automated Logging Config</p>
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.auto_logging.AutoLoggerConfig.FILE_LOGGING_LEVEL">
                
 
                            +<span class="sig-name descname"><span class="pre">FILE_LOGGING_LEVEL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DEBUG'</span></em><a class="headerlink" href="#super_gradients.common.auto_logging.AutoLoggerConfig.FILE_LOGGING_LEVEL" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.auto_logging.AutoLoggerConfig.CONSOLE_LOGGING_LEVEL">
                
 
                            +<span class="sig-name descname"><span class="pre">CONSOLE_LOGGING_LEVEL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'INFO'</span></em><a class="headerlink" href="#super_gradients.common.auto_logging.AutoLoggerConfig.CONSOLE_LOGGING_LEVEL" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.auto_logging.AutoLoggerConfig.filename">
                
 
                            +<span class="sig-name descname"><span class="pre">filename</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#super_gradients.common.auto_logging.AutoLoggerConfig.filename" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.auto_logging.AutoLoggerConfig.get_instance">
                
 
                            +<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_instance</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/auto_logging/auto_logger.html#AutoLoggerConfig.get_instance"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.auto_logging.AutoLog
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.auto_logging.AutoLoggerConfig.get_log_file_path">
                
 
                            +<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_log_file_path</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/super_gradients/common/auto_logging/auto_logger.html#AutoLoggerConfig.get_l
                
 
                            +<dd><p>Return the current log file used to store log messages
                
 
                            +:return: Full path to log file</p>
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.auto_logging.AutoLoggerConfig.setup_logging">
                
 
                            +<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setup_logging</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy_already_logged_messages</span></sp
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<dl class="py class">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.auto_logging.ConsoleSink">
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.auto_logging.</span></span><span class="sig-name descname"><span class="pre">ConsoleSink</span></span><a class="reference internal" href="_modules/super_gradients/common/auto_logging/console_logging.html#ConsoleSink"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.comm
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
                
 
                            +<p>Singleton responsible to sink the console streams (stdout/stderr) into a file.</p>
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.auto_logging.ConsoleSink.set_location">
                
 
                            +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_location</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span>
                
 
                            +<dd><p>Copy and redirect the sink file into another location.</p>
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.auto_logging.ConsoleSink.flush">
                
 
                            +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">flush</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/auto_logging/console_logging.html#ConsoleSink.flush"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.auto_logging.ConsoleSink.flush" title="P
                
 
                            +<dd><p>Force the flush on stdout and stderr.</p>
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.auto_logging.ConsoleSink.get_filename">
                
 
                            +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_filename</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/auto_logging/console_logging.html#ConsoleSink.get_filename"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.auto_logging.ConsoleSink.g
                
 
                            +<dd><p>Get the filename of the sink.</p>
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<span class="target" id="module-super_gradients.common.data_connection"></span><dl class="py class">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector">
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.data_connection.</span></span><span class="sig-name descname"><span class="pre">S3Connector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ILogger</span></code></p>
                
 
                            +<p>S3Connector - S3 Connection Manager</p>
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.check_key_exists">
                
 
                            +<span class="sig-name descname"><span class="pre">check_key_exists</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.check_key_exists" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.get_object_by_etag">
                
 
                            +<span class="sig-name descname"><span class="pre">get_object_by_etag</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.get_object_by_etag" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.create_bucket">
                
 
                            +<span class="sig-name descname"><span class="pre">create_bucket</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.create_bucket" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.delete_bucket">
                
 
                            +<span class="sig-name descname"><span class="pre">delete_bucket</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.delete_bucket" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.get_object_metadata">
                
 
                            +<span class="sig-name descname"><span class="pre">get_object_metadata</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.get_object_metadata" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.delete_key">
                
 
                            +<span class="sig-name descname"><span class="pre">delete_key</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.delete_key" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.upload_file_from_stream">
                
 
                            +<span class="sig-name descname"><span class="pre">upload_file_from_stream</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.upload_file_from_stream" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.upload_file">
                
 
                            +<span class="sig-name descname"><span class="pre">upload_file</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.upload_file" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.download_key">
                
 
                            +<span class="sig-name descname"><span class="pre">download_key</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.download_key" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.download_keys_by_prefix">
                
 
                            +<span class="sig-name descname"><span class="pre">download_keys_by_prefix</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.download_keys_by_prefix" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.download_file_by_path">
                
 
                            +<span class="sig-name descname"><span class="pre">download_file_by_path</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.download_file_by_path" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.empty_folder_content_by_path_prefix">
                
 
                            +<span class="sig-name descname"><span class="pre">empty_folder_content_by_path_prefix</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.empty_folder_content_by_path_prefix" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.upload_buffer">
                
 
                            +<span class="sig-name descname"><span class="pre">upload_buffer</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.upload_buffer" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.list_bucket_objects">
                
 
                            +<span class="sig-name descname"><span class="pre">list_bucket_objects</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.list_bucket_objects" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.create_presigned_upload_url">
                
 
                            +<span class="sig-name descname"><span class="pre">create_presigned_upload_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.create_presigned_upload_url" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.create_presigned_download_url">
                
 
                            +<span class="sig-name descname"><span class="pre">create_presigned_download_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.create_presigned_download_url" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.convert_content_length_to_mb">
                
 
                            +<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">convert_content_length_to_mb</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content_length</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_connection/s3_connector.html#S3Connector.convert_content_length_to_mb"><span class="viewcode-link"><
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_connection.S3Connector.copy_key">
                
 
                            +<span class="sig-name descname"><span class="pre">copy_key</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_connection.S3Connector.copy_key" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<span class="target" id="module-super_gradients.common.data_interface"></span><dl class="py class">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_interface.DatasetDataInterface">
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.data_interface.</span></span><span class="sig-name descname"><span class="pre">DatasetDataInterface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></s
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_interface.DatasetDataInterface.load_remote_dataset_file">
                
 
                            +<span class="sig-name descname"><span class="pre">load_remote_dataset_file</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_interface.DatasetDataInterface.load_remote_dataset_file" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<dl class="py class">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces">
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.data_interface.</span></span><span class="sig-name descname"><span class="pre">ADNNModelRepositoryDataInterfaces</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_connection_location</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ILogger</span></code></p>
                
 
                            +<p>ResearchModelRepositoryDataInterface</p>
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.load_all_remote_log_files">
                
 
                            +<span class="sig-name descname"><span class="pre">load_all_remote_log_files</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.load_all_remote_log_files" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.save_all_remote_checkpoint_files">
                
 
                            +<span class="sig-name descname"><span class="pre">save_all_remote_checkpoint_files</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.save_all_remote_checkpoint_files" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.load_remote_checkpoints_file">
                
 
                            +<span class="sig-name descname"><span class="pre">load_remote_checkpoints_file</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.load_remote_checkpoints_file" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.load_remote_logging_files">
                
 
                            +<span class="sig-name descname"><span class="pre">load_remote_logging_files</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.load_remote_logging_files" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.save_remote_checkpoints_file">
                
 
                            +<span class="sig-name descname"><span class="pre">save_remote_checkpoints_file</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.save_remote_checkpoints_file" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.save_remote_tensorboard_event_files">
                
 
                            +<span class="sig-name descname"><span class="pre">save_remote_tensorboard_event_files</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#super_gradients.common.data_interface.ADNNModelRepositoryDataInterfaces.save_remote_tensorboard_event_files" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<span class="target" id="module-super_gradients.common.data_types"></span><dl class="py class">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.StrictLoad">
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.data_types.</span></span><span class="sig-name descname"><span class="pre">StrictLoad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/strict_load
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
                
 
                            +<p>Wrapper for adding more functionality to torch’s strict_load parameter in load_state_dict().
                
 
                            +.. attribute:: OFF              - Native torch “strict_load = off” behaviour. See nn.Module.load_state_dict() documentation for more details.</p>
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py">
                
 
                            +<span class="sig-name descname"><span class="pre">ON</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">-</span> <span class="pre">Native</span> <span class="pre">torch</span> <span class="pre">&quot;strict_load</span> <span class="pre">=</span> <span class="pre">on&quot;</span> <span class="pre">behaviour.</span> <span class="pre">See</span> <span class="pre">nn.Module.load_state_dict()</span> <span class="pre">documentation</span> <spa
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py">
                
 
                            +<span class="sig-name descname"><span class="pre">NO_KEY_MATCHING</span>&#160; <span class="pre">-</span> <span class="pre">Allows</span> <span class="pre">the</span> <span class="pre">usage</span> <span class="pre">of</span> <span class="pre">SuperGradient's</span> <span class="pre">adapt_checkpoint</span> <span class="pre">function,</span> <span class="pre">which</span> <span class="pre">loads</span> <span class="pre">a</span> <span class="pre">checkpoint</span> <span class="pre">by</span> <s
                
 
                            +<dd><p>layer’s shapes (and bypasses the strict matching of the names of each layer (ie: disregards the state_dict key matching)).</p>
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.StrictLoad.OFF">
                
 
                            +<span class="sig-name descname"><span class="pre">OFF</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#super_gradients.common.data_types.StrictLoad.OFF" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.StrictLoad.ON">
                
 
                            +<span class="sig-name descname"><span class="pre">ON</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#super_gradients.common.data_types.StrictLoad.ON" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.StrictLoad.NO_KEY_MATCHING">
                
 
                            +<span class="sig-name descname"><span class="pre">NO_KEY_MATCHING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'no_key_matching'</span></em><a class="headerlink" href="#super_gradients.common.data_types.StrictLoad.NO_KEY_MATCHING" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<dl class="py class">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.DeepLearningTask">
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.data_types.</span></span><span class="sig-name descname"><span class="pre">DeepLearningTask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/deep_
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
                
 
                            +<p>An enumeration.</p>
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.DeepLearningTask.CLASSIFICATION">
                
 
                            +<span class="sig-name descname"><span class="pre">CLASSIFICATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'classification'</span></em><a class="headerlink" href="#super_gradients.common.data_types.DeepLearningTask.CLASSIFICATION" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.DeepLearningTask.SEMANTIC_SEGMENTATION">
                
 
                            +<span class="sig-name descname"><span class="pre">SEMANTIC_SEGMENTATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'semantic_segmentation'</span></em><a class="headerlink" href="#super_gradients.common.data_types.DeepLearningTask.SEMANTIC_SEGMENTATION" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.DeepLearningTask.OBJECT_DETECTION">
                
 
                            +<span class="sig-name descname"><span class="pre">OBJECT_DETECTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'object_detection'</span></em><a class="headerlink" href="#super_gradients.common.data_types.DeepLearningTask.OBJECT_DETECTION" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.DeepLearningTask.DEPTH_ESTIMATION">
                
 
                            +<span class="sig-name descname"><span class="pre">DEPTH_ESTIMATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'depth_estimation'</span></em><a class="headerlink" href="#super_gradients.common.data_types.DeepLearningTask.DEPTH_ESTIMATION" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.DeepLearningTask.POSE_ESTIMATION">
                
 
                            +<span class="sig-name descname"><span class="pre">POSE_ESTIMATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pose_estimation'</span></em><a class="headerlink" href="#super_gradients.common.data_types.DeepLearningTask.POSE_ESTIMATION" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.DeepLearningTask.NLP">
                
 
                            +<span class="sig-name descname"><span class="pre">NLP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'nlp'</span></em><a class="headerlink" href="#super_gradients.common.data_types.DeepLearningTask.NLP" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.DeepLearningTask.OTHER">
                
 
                            +<span class="sig-name descname"><span class="pre">OTHER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'other'</span></em><a class="headerlink" href="#super_gradients.common.data_types.DeepLearningTask.OTHER" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<dl class="py class">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.EvaluationType">
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.data_types.</span></span><span class="sig-name descname"><span class="pre">EvaluationType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/evaluat
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
                
 
                            +<p>Passed to Trainer.evaluate(..), and controls which phase callbacks should be triggered (if at all).</p>
                
 
                            +<blockquote>
                
 
                            +<div><dl class="simple">
                
 
                            +<dt>Attributes:</dt><dd><p>TEST
                
 
                            +VALIDATION</p>
                
 
                            +</dd>
                
 
                            +</dl>
                
 
                            +</div></blockquote>
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.EvaluationType.TEST">
                
 
                            +<span class="sig-name descname"><span class="pre">TEST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TEST'</span></em><a class="headerlink" href="#super_gradients.common.data_types.EvaluationType.TEST" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.EvaluationType.VALIDATION">
                
 
                            +<span class="sig-name descname"><span class="pre">VALIDATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'VALIDATION'</span></em><a class="headerlink" href="#super_gradients.common.data_types.EvaluationType.VALIDATION" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<dl class="py class">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.MultiGPUMode">
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.data_types.</span></span><span class="sig-name descname"><span class="pre">MultiGPUMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/multi_gpu
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py">
                
 
                            +<span class="sig-name descname"><span class="pre">OFF</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">-</span> <span class="pre">Single</span> <span class="pre">GPU</span> <span class="pre">Mode</span> <span class="pre">/</span> <span class="pre">CPU</span> <span class="pre">Mode</span></span></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py">
                
 
                            +<span class="sig-name descname"><span class="pre">DATA_PARALLEL</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">-</span> <span class="pre">Multiple</span> <span class="pre">GPUs,</span> <span class="pre">Synchronous</span></span></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py">
                
 
                            +<span class="sig-name descname"><span class="pre">DISTRIBUTED_DATA_PARALLEL</span> <span class="pre">-</span> <span class="pre">Multiple</span> <span class="pre">GPUs,</span> <span class="pre">Asynchronous</span></span></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.MultiGPUMode.OFF">
                
 
                            +<span class="sig-name descname"><span class="pre">OFF</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Off'</span></em><a class="headerlink" href="#super_gradients.common.data_types.MultiGPUMode.OFF" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.MultiGPUMode.DATA_PARALLEL">
                
 
                            +<span class="sig-name descname"><span class="pre">DATA_PARALLEL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DP'</span></em><a class="headerlink" href="#super_gradients.common.data_types.MultiGPUMode.DATA_PARALLEL" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.MultiGPUMode.DISTRIBUTED_DATA_PARALLEL">
                
 
                            +<span class="sig-name descname"><span class="pre">DISTRIBUTED_DATA_PARALLEL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DDP'</span></em><a class="headerlink" href="#super_gradients.common.data_types.MultiGPUMode.DISTRIBUTED_DATA_PARALLEL" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.MultiGPUMode.AUTO">
                
 
                            +<span class="sig-name descname"><span class="pre">AUTO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'AUTO'</span></em><a class="headerlink" href="#super_gradients.common.data_types.MultiGPUMode.AUTO" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>
                
 
                            +
                
 
                            +<dl class="py method">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.MultiGPUMode.dict">
                
 
                            +<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/multi_gpu_mode.html#MultiGPUMode.dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#super_gradients.common.data_types.MultiGPUMode.dict" titl
                
 
                            +<dd><p>return dictionary mapping from the mode name (in call string cases) to the enum value</p>
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +</dd></dl>
                
 
                            +
                
 
                            +<dl class="py class">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.UpsampleMode">
                
 
                            +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">super_gradients.common.data_types.</span></span><span class="sig-name descname"><span class="pre">UpsampleMode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/super_gradients/common/data_types/enum/upsample_
                
 
                            +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
                
 
                            +<p>An enumeration.</p>
                
 
                            +<dl class="py attribute">
                
 
                            +<dt class="sig sig-object py" id="super_gradients.common.data_types.UpsampleMode.NEAREST">
                
 
                            +<span class="sig-name descname"><span class="pre">NEAREST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'nearest'</span></em><a class="headerlink" href="#super_gradients.common.data_types.UpsampleMode.NEAREST" title="Permalink to this definition"></a></dt>
                
 
                            +<dd></dd></dl>