Added docu for final challenge and for changed format for how challenges are stored

AKuederle · AKuederle · commit 4eeadcf81c3d · 2023-09-20T14:34:53.000+02:00
diff --git a/docs/challenges/Full Pipeline/Kluge2017/code_objects.rst b/docs/challenges/Full Pipeline/Kluge2017/code_objects.rst
@@ -0,0 +1,17 @@
+Code Objects
+============
+
+.. currentmodule:: gaitmap_challenges.full_pipeline.kluge_2017
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: class.rst
+
+    Challenge
+    ChallengeDataset
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: function.rst
+
+    final_scorer
diff --git a/docs/challenges/Full Pipeline/Kluge2017/index.rst b/docs/challenges/Full Pipeline/Kluge2017/index.rst
@@ -4,27 +4,11 @@ Kluge2017 - Full Pipeline
 .. toctree::
    :glob:
    :maxdepth: 1
+   :caption: Further Links:
 
-   Link to Result Page <results>
+   Results <results>
+   Code Objects <code_objects>
 
 .. automodule:: gaitmap_challenges.full_pipeline.kluge_2017
     :no-members:
     :no-inherited-members:
-
-Code Objects
-------------
-
-.. currentmodule:: gaitmap_challenges.full_pipeline.kluge_2017
-
-.. autosummary::
-   :toctree: generated/
-   :template: class.rst
-
-    Challenge
-    ChallengeDataset
-
-.. autosummary::
-   :toctree: generated/
-   :template: function.rst
-
-    final_scorer
diff --git a/docs/challenges/Full Pipeline/SensorPositionComparison/code_objects.rst b/docs/challenges/Full Pipeline/SensorPositionComparison/code_objects.rst
@@ -0,0 +1,17 @@
+Code Objects
+============
+
+.. currentmodule:: gaitmap_challenges.full_pipeline.sensor_position_comparison_instep
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: class.rst
+
+    Challenge
+    ChallengeDataset
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: function.rst
+
+    final_scorer
diff --git a/docs/challenges/Full Pipeline/SensorPositionComparison/index.rst b/docs/challenges/Full Pipeline/SensorPositionComparison/index.rst
@@ -4,27 +4,12 @@ SensorPositionComparison - Full Pipeline
 .. toctree::
    :glob:
    :maxdepth: 1
+   :caption: Further Links:
 
-   Link to Result Page <results>
+   Results <results>
+   Code Objects <code_objects>
 
 .. automodule:: gaitmap_challenges.full_pipeline.sensor_position_comparison_instep
     :no-members:
     :no-inherited-members:
 
-Code Objects
-------------
-
-.. currentmodule:: gaitmap_challenges.full_pipeline.sensor_position_comparison_instep
-
-.. autosummary::
-   :toctree: generated/
-   :template: class.rst
-
-    Challenge
-    ChallengeDataset
-
-.. autosummary::
-   :toctree: generated/
-   :template: function.rst
-
-    final_scorer
diff --git a/docs/challenges/Spatial Parameter/EgaitAddidas2014/code_objects.rst b/docs/challenges/Spatial Parameter/EgaitAddidas2014/code_objects.rst
@@ -0,0 +1,17 @@
+Code Objects
+============
+
+.. currentmodule:: gaitmap_challenges.spatial_parameters.egait_adidas_2014
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: class.rst
+
+    Challenge
+    ChallengeDataset
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: function.rst
+
+    final_scorer
diff --git a/docs/challenges/Spatial Parameter/EgaitAddidas2014/index.rst b/docs/challenges/Spatial Parameter/EgaitAddidas2014/index.rst
@@ -4,27 +4,11 @@ EgaitAdidas2014 - Spatial Parameters
 .. toctree::
    :glob:
    :maxdepth: 1
+   :caption: Further Links:
 
-   Link to Result Page <results>
+   Results <results>
+   Code Objects <code_objects>
 
 .. automodule:: gaitmap_challenges.spatial_parameters.egait_adidas_2014
     :no-members:
     :no-inherited-members:
-
-Code Objects
-------------
-
-.. currentmodule:: gaitmap_challenges.spatial_parameters.egait_adidas_2014
-
-.. autosummary::
-   :toctree: generated/
-   :template: class.rst
-
-    Challenge
-    ChallengeDataset
-
-.. autosummary::
-   :toctree: generated/
-   :template: function.rst
-
-    final_scorer
diff --git a/docs/challenges/Spatial Parameter/EgaitParameterValidation2013/code_objects.rst b/docs/challenges/Spatial Parameter/EgaitParameterValidation2013/code_objects.rst
@@ -0,0 +1,17 @@
+Code Objects
+============
+
+.. currentmodule:: gaitmap_challenges.spatial_parameters.egait_parameter_validation_2013
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: class.rst
+
+    Challenge
+    ChallengeDataset
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: function.rst
+
+    final_scorer
diff --git a/docs/challenges/Spatial Parameter/EgaitParameterValidation2013/index.rst b/docs/challenges/Spatial Parameter/EgaitParameterValidation2013/index.rst
@@ -4,27 +4,11 @@ EgaitParameterValidation2013 - Spatial Parameters
 .. toctree::
    :glob:
    :maxdepth: 1
+   :caption: Further Links:
 
-   Link to Result Page <results>
+   Results <results>
+   Code Objects <code_objects>
 
 .. automodule:: gaitmap_challenges.spatial_parameters.egait_parameter_validation_2013
     :no-members:
     :no-inherited-members:
-
-Code Objects
-------------
-
-.. currentmodule:: gaitmap_challenges.spatial_parameters.egait_parameter_validation_2013
-
-.. autosummary::
-   :toctree: generated/
-   :template: class.rst
-
-    Challenge
-    ChallengeDataset
-
-.. autosummary::
-   :toctree: generated/
-   :template: function.rst
-
-    final_scorer
diff --git a/docs/challenges/Spatial Parameter/SensorPostionComparisonInstep/code_objects.rst b/docs/challenges/Spatial Parameter/SensorPostionComparisonInstep/code_objects.rst
@@ -0,0 +1,17 @@
+Code Objects
+============
+
+.. currentmodule:: gaitmap_challenges.spatial_parameters.sensor_position_comparison_instep
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: class.rst
+
+    Challenge
+    ChallengeDataset
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: function.rst
+
+    final_scorer
diff --git a/docs/challenges/Spatial Parameter/SensorPostionComparisonInstep/index.rst b/docs/challenges/Spatial Parameter/SensorPostionComparisonInstep/index.rst
@@ -4,27 +4,11 @@ SensorPositionComparison - Spatial Parameters
 .. toctree::
    :glob:
    :maxdepth: 1
+   :caption: Further Links:
 
-   Link to Result Page <results>
+   Results <results>
+   Code Objects <code_objects>
 
 .. automodule:: gaitmap_challenges.spatial_parameters.sensor_position_comparison_instep
     :no-members:
     :no-inherited-members:
-
-Code Objects
-------------
-
-.. currentmodule:: gaitmap_challenges.spatial_parameters.sensor_position_comparison_instep
-
-.. autosummary::
-   :toctree: generated/
-   :template: class.rst
-
-    Challenge
-    ChallengeDataset
-
-.. autosummary::
-   :toctree: generated/
-   :template: function.rst
-
-    final_scorer
diff --git a/docs/challenges/Stride Segmentation/EgaitSegmentationValidation2014/code_objects.rst b/docs/challenges/Stride Segmentation/EgaitSegmentationValidation2014/code_objects.rst
@@ -0,0 +1,17 @@
+Code Objects
+============
+
+.. currentmodule:: gaitmap_challenges.stride_segmentation.egait_segmentation_validation_2014
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: class.rst
+
+    Challenge
+    ChallengeDataset
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: function.rst
+
+    final_scorer
diff --git a/docs/challenges/Stride Segmentation/EgaitSegmentationValidation2014/index.rst b/docs/challenges/Stride Segmentation/EgaitSegmentationValidation2014/index.rst
@@ -4,27 +4,11 @@ EgaitSegmentationValidation2014
 .. toctree::
    :glob:
    :maxdepth: 1
+   :caption: Further Links:
 
-   Link to Result Page <results>
+   Results <results>
+   Code Objects <code_objects>
 
 .. automodule:: gaitmap_challenges.stride_segmentation.egait_segmentation_validation_2014
     :no-members:
     :no-inherited-members:
-
-Code Objects
-------------
-
-.. currentmodule:: gaitmap_challenges.stride_segmentation.egait_segmentation_validation_2014
-
-.. autosummary::
-   :toctree: generated/
-   :template: class.rst
-
-    Challenge
-    ChallengeDataset
-
-.. autosummary::
-   :toctree: generated/
-   :template: function.rst
-
-    final_scorer
diff --git a/docs/challenges/Stride Segmentation/EgaitSegmentationValidation2014OriginalLabel/code_objects.rst b/docs/challenges/Stride Segmentation/EgaitSegmentationValidation2014OriginalLabel/code_objects.rst
@@ -0,0 +1,17 @@
+Code Objects
+============
+
+.. currentmodule:: gaitmap_challenges.stride_segmentation.egait_segmentation_validation_2014_original_label
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: class.rst
+
+    Challenge
+    ChallengeDataset
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: function.rst
+
+    final_scorer
diff --git a/docs/challenges/Stride Segmentation/EgaitSegmentationValidation2014OriginalLabel/index.rst b/docs/challenges/Stride Segmentation/EgaitSegmentationValidation2014OriginalLabel/index.rst
@@ -4,27 +4,11 @@ EgaitSegmentationValidation2014 - Original Labels
 .. toctree::
    :glob:
    :maxdepth: 1
+   :caption: Further Links:
 
-   Link to Result Page <results>
+   Results <results>
+   Code Objects <code_objects>
 
 .. automodule:: gaitmap_challenges.stride_segmentation.egait_segmentation_validation_2014_original_label
     :no-members:
     :no-inherited-members:
-
-Code Objects
-------------
-
-.. currentmodule:: gaitmap_challenges.stride_segmentation.egait_segmentation_validation_2014_original_label
-
-.. autosummary::
-   :toctree: generated/
-   :template: class.rst
-
-    Challenge
-    ChallengeDataset
-
-.. autosummary::
-   :toctree: generated/
-   :template: function.rst
-
-    final_scorer
diff --git a/docs/challenges/Stride Segmentation/SensorPositionComparisonInstep/code_objects.rst b/docs/challenges/Stride Segmentation/SensorPositionComparisonInstep/code_objects.rst
@@ -0,0 +1,17 @@
+Code Objects
+============
+
+.. currentmodule:: gaitmap_challenges.stride_segmentation.sensor_position_comparison_instep
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: class.rst
+
+    Challenge
+    ChallengeDataset
+
+.. autosummary::
+   :toctree: ../../generated/
+   :template: function.rst
+
+    final_scorer
diff --git a/docs/challenges/Stride Segmentation/SensorPositionComparisonInstep/index.rst b/docs/challenges/Stride Segmentation/SensorPositionComparisonInstep/index.rst
@@ -0,0 +1,14 @@
+SensorPositionComparison - Stride Segmentation
+==============================================
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+   :caption: Further Links:
+
+   Results <results>
+   Code Objects <code_objects>
+
+.. automodule:: gaitmap_challenges.stride_segmentation.sensor_position_comparison_instep
+    :no-members:
+    :no-inherited-members:
diff --git a/docs/challenges/Stride Segmentation/SensorPositionComparisonInstep/results.ipynb b/docs/challenges/Stride Segmentation/SensorPositionComparisonInstep/results.ipynb
diff --git a/gaitmap-challenges/gaitmap_challenges/stride_segmentation/sensor_position_comparison_instep.py b/gaitmap-challenges/gaitmap_challenges/stride_segmentation/sensor_position_comparison_instep.py
