Merge pull request #89 from PGijsbers/develop

Update documentation
openml-labs · Apr 24, 2020 · 565f48e · 565f48e
2 parents f12547e + 30a17db
commit 565f48e
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 3 deletions.
diff --git a/docs/source/benchmark.rst b/docs/source/benchmark.rst
@@ -0,0 +1,13 @@
+:orphan:
+
+Benchmark Results
+=================
+
+.. note::  Additional results will be uploaded soon.
+
+This page reports the benchmark results obtained by running GAMA on the `AutoML benchmark <https://openml.github.io/automlbenchmark/automl_overview.html>`_.
+Note that the performance of other AutoML frameworks is taken from the original benchmark experiments, they are not reproduced by us.
+Some results on this page may have been performed on other hardware than aws nodes, but care is taken that the resources available match.
+We will do our best to keep the results complete and up to date.
+
+.. image:: images/benchmark.png
diff --git a/docs/source/images/benchmark.png b/docs/source/images/benchmark.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -36,6 +36,7 @@ If your question has not been answered there either, please open a new issue.
    user_guide/index
    technical_guide/index
    api/index
+   benchmark
    releases
    contributing/index
    citing
diff --git a/docs/source/technical_guide/logging.rst b/docs/source/technical_guide/logging.rst
@@ -53,4 +53,4 @@ An overview the log levels:
 By default GAMA will also capture log output to a file named 'gama.log'.
 You can use the `keep_analysis_log` hyperparameter to specify the desired location and name of the log,
 or set it to `None` to prevent it being produced in the first place.
-As described in :ref:`visualization` this file can be used to generate visualizations about the optimization process.
+As described in :ref:`Dashboard` this file can be used to generate visualizations about the optimization process.
diff --git a/docs/source/user_guide/dashboard.rst b/docs/source/user_guide/dashboard.rst
@@ -1,5 +1,8 @@
 :orphan:
 
+
+.. _dashboard:
+
 Dashboard
 ---------
 
@@ -49,7 +52,7 @@ You see four main components on this page:
 Selecting a pipeline in the table or through the plot will update the other components.
 
 Analysis tab
-***********
+************
 
 The analysis tab is also available if you did not start a new GAMA run.
 On this tab, you can visualize search results from logs.

diff --git a/docs/source/user_guide/simple_features.rst b/docs/source/user_guide/simple_features.rst
@@ -3,7 +3,7 @@
 Simple Features
 ---------------
 This section features a couple of simple to use features that might be interesting for a wide audience.
-For more advanced features, see the :ref:`_technical_guide_index`.
+For more advanced features, see the :ref:`Technical Guide`.
 
 Command Line Interface
 **********************