Various improvements to documentation

AutoTuningAssociation · May 13, 2024 · 70b5e4d · 70b5e4d
1 parent b0f243d
commit 70b5e4d
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 9 deletions.
diff --git a/docs/autotuning_methodology.rst b/docs/autotuning_methodology.rst
@@ -6,7 +6,7 @@ Module contents
    :undoc-members:
    :show-inheritance:
 
-autotuning\_methodology.baseline module
+Baseline module
 ---------------------------------------
 .. inheritance-diagram:: src.autotuning_methodology.baseline
     :parts: 1
@@ -16,7 +16,7 @@ autotuning\_methodology.baseline module
    :undoc-members:
    :show-inheritance:
 
-autotuning\_methodology.caching module
+Caching module
 --------------------------------------
 .. inheritance-diagram:: src.autotuning_methodology.caching
     :parts: 1
@@ -26,7 +26,7 @@ autotuning\_methodology.caching module
    :undoc-members:
    :show-inheritance:
 
-autotuning\_methodology.curves module
+Curves module
 -------------------------------------
 .. inheritance-diagram:: src.autotuning_methodology.curves
     :parts: 1
@@ -36,23 +36,23 @@ autotuning\_methodology.curves module
    :undoc-members:
    :show-inheritance:
 
-autotuning\_methodology.experiments module
+Experiments module
 ------------------------------------------
 
 .. automodule:: autotuning_methodology.experiments
    :members:
    :undoc-members:
    :show-inheritance:
 
-autotuning\_methodology.runner module
+Runner module
 -------------------------------------
 
 .. automodule:: autotuning_methodology.runner
    :members:
    :undoc-members:
    :show-inheritance:
 
-autotuning\_methodology.searchspace\_statistics module
+Searchspace statistics module
 ------------------------------------------------------
 .. inheritance-diagram:: src.autotuning_methodology.searchspace_statistics
     :parts: 1
@@ -62,7 +62,7 @@ autotuning\_methodology.searchspace\_statistics module
    :undoc-members:
    :show-inheritance:
 
-autotuning\_methodology.visualize\_experiments module
+Visualize experiments module
 -----------------------------------------------------
 .. inheritance-diagram:: src.autotuning_methodology.visualize_experiments
     :parts: 1

diff --git a/docs/index.rst b/docs/index.rst
@@ -8,7 +8,6 @@ Getting started
 ---------------
  .. include:: getting_started.rst
 
-
 .. .. automodule:: src.autotuning_methodology.experiments
 ..     :members:
 
@@ -17,7 +16,7 @@ Getting started
 
 .. toctree::
    :caption: Contents:
-   :maxdepth: 2
+   :maxdepth: 1
 
    modules
 

diff --git a/docs/modules.rst b/docs/modules.rst
@@ -4,4 +4,5 @@
 .. toctree::
    :maxdepth: 4
 
+   getting_started
    autotuning_methodology
diff --git a/experiment_files/simple_example.json b/experiment_files/simple_example.json
@@ -0,0 +1,56 @@
+{
+    "version": "0.1.2", // schema version
+    "name": "Example", // experiment name
+    "folder_id": "example", // folder ID to write to (must be unique)
+    "kernels_path": "../cached_data_used/kernels", // path to the kernels
+    "bruteforced_caches_path": "../cached_data_used/cachefiles", // path to the bruteforced cachefiles
+    "visualization_caches_path": "../cached_data_used/visualizations", // path to the folder ID
+    "kernels": [
+        "convolution"
+    ], // list of kernels to evaluate with
+    "GPUs": [
+        "RTX_3090"
+    ], // list of GPUs to evaluate on
+    "cutoff_percentile": 0.96, // percentile of distance between median and optimum at which to stop 
+    "objective_time_keys": [ // list of keys to use as time objective
+        "compilation",
+        "benchmark",
+        "framework",
+        "search_algorithm",
+        "validation"
+    ],
+    "objective_performance_keys": [ // list of keys to use as performance objective
+        "time"
+    ],
+    "plot": {
+        "plot_x_value_types": [
+            "aggregated"
+        ], // list of plot x-axis types
+        "plot_y_value_types": [
+            "baseline"
+        ], // list of plot y-axis types
+        "confidence_level": 0.95 // confidence level for the error shade
+    },
+    "strategy_defaults": { // these defaults are applied to all strategies
+        "record_data": [
+            "time",
+            "GFLOP/s"
+        ] // the data to record
+        "stochastic": true, // whether the strategy has stochastic behaviour
+        "iterations": 32, // number of times an individual configuration is repeated
+        "repeats": 100, // number of times a strategy is repeated
+        "minimum_number_of_evaluations": 20, // minimum number of non-error results to count as a single run
+    },
+    "strategies": [ // the list of strategies or algorithm to evaluate
+        {
+            "name": "genetic_algorithm", // the name of the strategy (for internal use, must be unique)
+            "strategy": "genetic_algorithm", // the strategy as specified by the auto-tuning framework
+            "display_name": "Genetic Algorithm" // the name of the strategy used in plots and other visualization
+        },
+        {
+            "name": "ktt_profile_searcher",
+            "strategy": "profile_searcher",
+            "display_name": "KTT Profile Searcher"
+        }
+    ]
+}