deploy: 5feb802

_modules/index.html

@@ -73,8 +73,7 @@
            <div itemprop="articleBody">
 
   <h1>All modules for which code is available</h1>
-<ul><li><a href="ssl_tools/experiments/lightning_cli.html">ssl_tools.experiments.lightning_cli</a></li>
-<li><a href="ssl_tools/utils/configurable.html">ssl_tools.utils.configurable</a></li>
+<ul><li><a href="ssl_tools/utils/configurable.html">ssl_tools.utils.configurable</a></li>
 <li><a href="ssl_tools/utils/data.html">ssl_tools.utils.data</a></li>
 </ul>
 

_sources/autoapi/ssl_tools/experiments/experiment/index.rst.txt

@@ -0,0 +1,86 @@
+:py:mod:`ssl_tools.experiments.experiment`
+==========================================
+
+.. py:module:: ssl_tools.experiments.experiment
+
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+   ssl_tools.experiments.experiment.Experiment
+
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   ssl_tools.experiments.experiment.auto_main
+   ssl_tools.experiments.experiment.get_parser
+
+
+
+Attributes
+~~~~~~~~~~
+
+.. autoapisummary::
+
+   ssl_tools.experiments.experiment.EXPERIMENT_VERSION_FORMAT
+
+
+.. py:data:: EXPERIMENT_VERSION_FORMAT
+   :value: '%Y-%m-%d_%H-%M-%S'
+
+
+
+.. py:class:: Experiment(name = 'experiment', run_id = None, log_dir = 'logs', seed = None)
+
+
+   Bases: :py:obj:`abc.ABC`
+
+   Helper class that provides a standard way to create an ABC using
+   inheritance.
+
+   .. py:property:: experiment_dir
+      :type: pathlib.Path
+
+
+   .. py:method:: __call__()
+
+
+   .. py:method:: __repr__()
+
+      Return repr(self).
+
+
+   .. py:method:: __str__()
+
+      Return str(self).
+
+
+   .. py:method:: execute()
+
+
+   .. py:method:: run()
+      :abstractmethod:
+
+
+   .. py:method:: setup()
+
+
+   .. py:method:: teardown()
+
+
+
+.. py:function:: auto_main(commands)
+
+
+.. py:function:: get_parser(commands)
+
+

_sources/autoapi/ssl_tools/experiments/har_classification/cpc/index.rst.txt

@@ -17,21 +17,23 @@ Classes
 
 
 
-Functions
-~~~~~~~~~
 
-.. autoapisummary::
+Attributes
+~~~~~~~~~~
 
-   ssl_tools.experiments.har_classification.cpc.main
+.. autoapisummary::
 
+   ssl_tools.experiments.har_classification.cpc.options
 
 
 .. py:class:: CPCTest(data, encoding_size = 150, in_channel = 6, window_size = 4, num_classes = 6, *args, **kwargs)
 
 
-   Bases: :py:obj:`ssl_tools.experiments.SSLTest`
+   Bases: :py:obj:`ssl_tools.experiments.LightningTest`
+
+   Helper class that provides a standard way to create an ABC using
+   inheritance.
 
-
    Trains the constrastive predictive coding model
 
    Parameters
@@ -53,33 +55,35 @@ Functions
 
 
 
-   .. py:method:: _get_test_data_module()
+   .. py:method:: get_data_module()
 
-      The data module to use for testing.
+      Get the datamodule to use for the experiment.
 
       Returns
       -------
       L.LightningDataModule
-          The data module to use for testing
+          The datamodule to use for the experiment
 
 
-   .. py:method:: _get_test_model(load_backbone = None)
+   .. py:method:: get_model(load_backbone = None)
 
-      Get the model to use for testing.
+      Get the model to use for the experiment.
 
       Returns
       -------
       L.LightningModule
-          The model to use for testing
+          The model to use for the experiment
 
 
 
 .. py:class:: CPCTrain(data, encoding_size = 150, in_channel = 6, window_size = 4, pad_length = False, num_classes = 6, update_backbone = False, *args, **kwargs)
 
 
-   Bases: :py:obj:`ssl_tools.experiments.SSLTrain`
+   Bases: :py:obj:`ssl_tools.experiments.LightningSSLTrain`
+
+   Helper class that provides a standard way to create an ABC using
+   inheritance.
 
-
    Trains the constrastive predictive coding model
 
    Parameters
@@ -104,7 +108,7 @@ Functions
 
 
 
-   .. py:method:: _get_finetune_data_module()
+   .. py:method:: get_finetune_data_module()
 
       The data module to use for fine-tuning.
 
@@ -119,14 +123,14 @@ Functions
           _description_
 
 
-   .. py:method:: _get_finetune_model(load_backbone = None)
+   .. py:method:: get_finetune_model(load_backbone = None)
 
       Get the model to use for fine-tuning.
 
       Parameters
       ----------
       load_backbone : str, optional
-          The path to the backbone to load. The backbone must be loaded 
+          The path to the backbone to load. The backbone must be loaded
           inside this method, if it is not None.
 
       Returns
@@ -135,7 +139,7 @@ Functions
           The model to use for fine-tuning
 
 
-   .. py:method:: _get_pretrain_data_module()
+   .. py:method:: get_pretrain_data_module()
 
       The data module to use for pre-training.
 
@@ -145,17 +149,18 @@ Functions
           The data module to use for pre-training
 
 
-   .. py:method:: _get_pretrain_model()
+   .. py:method:: get_pretrain_model()
 
-      Get the model to use for pre-training.
+      Get the model to use for the pretraining phase.
 
       Returns
       -------
       L.LightningModule
-          The model to use for pre-training
+          The model to use for the pretraining phase
 
 
 
-.. py:function:: main()
+.. py:data:: options
 
+   
 

_sources/autoapi/ssl_tools/experiments/har_classification/tfc/index.rst.txt

@@ -17,21 +17,23 @@ Classes
 
 
 
-Functions
-~~~~~~~~~
 
-.. autoapisummary::
+Attributes
+~~~~~~~~~~
 
-   ssl_tools.experiments.har_classification.tfc.main
+.. autoapisummary::
 
+   ssl_tools.experiments.har_classification.tfc.options
 
 
 .. py:class:: TFCTest(data, label = 'standard activity code', encoding_size = 128, in_channels = 6, length_alignment = 178, use_cosine_similarity = True, temperature = 0.5, features_as_channels = False, num_classes = 6, *args, **kwargs)
 
 
-   Bases: :py:obj:`ssl_tools.experiments.SSLTest`
+   Bases: :py:obj:`ssl_tools.experiments.LightningTest`
+
+   Helper class that provides a standard way to create an ABC using
+   inheritance.
 
-
    Tests the Temporal Frequency Coding model
 
    Parameters
@@ -75,33 +77,35 @@ Functions
 
 
 
-   .. py:method:: _get_test_data_module()
+   .. py:method:: get_data_module()
 
-      The data module to use for testing.
+      Get the datamodule to use for the experiment.
 
       Returns
       -------
       L.LightningDataModule
-          The data module to use for testing
+          The datamodule to use for the experiment
 
 
-   .. py:method:: _get_test_model()
+   .. py:method:: get_model()
 
-      Get the model to use for testing.
+      Get the model to use for the experiment.
 
       Returns
       -------
       L.LightningModule
-          The model to use for testing
+          The model to use for the experiment
 
 
 
 .. py:class:: TFCTrain(data, label = 'standard activity code', encoding_size = 128, in_channels = 6, length_alignment = 178, use_cosine_similarity = True, temperature = 0.5, features_as_channels = False, jitter_ratio = 2, num_classes = 6, update_backbone = False, *args, **kwargs)
 
 
-   Bases: :py:obj:`ssl_tools.experiments.SSLTrain`
+   Bases: :py:obj:`ssl_tools.experiments.LightningSSLTrain`
+
+   Helper class that provides a standard way to create an ABC using
+   inheritance.
 
-
    Trains the Temporal Frequency Coding model
 
    Parameters
@@ -145,7 +149,7 @@ Functions
 
 
 
-   .. py:method:: _get_finetune_data_module()
+   .. py:method:: get_finetune_data_module()
 
       The data module to use for fine-tuning.
 
@@ -160,14 +164,14 @@ Functions
           _description_
 
 
-   .. py:method:: _get_finetune_model(load_backbone = None)
+   .. py:method:: get_finetune_model(load_backbone = None)
 
       Get the model to use for fine-tuning.
 
       Parameters
       ----------
       load_backbone : str, optional
-          The path to the backbone to load. The backbone must be loaded 
+          The path to the backbone to load. The backbone must be loaded
           inside this method, if it is not None.
 
       Returns
@@ -176,7 +180,7 @@ Functions
           The model to use for fine-tuning
 
 
-   .. py:method:: _get_pretrain_data_module()
+   .. py:method:: get_pretrain_data_module()
 
       The data module to use for pre-training.
 
@@ -186,17 +190,18 @@ Functions
           The data module to use for pre-training
 
 
-   .. py:method:: _get_pretrain_model()
+   .. py:method:: get_pretrain_model()
 
-      Get the model to use for pre-training.
+      Get the model to use for the pretraining phase.
 
       Returns
       -------
       L.LightningModule
-          The model to use for pre-training
+          The model to use for the pretraining phase
 
 
 
-.. py:function:: main()
+.. py:data:: options
 
+