Extend documentation

SmartDataAnalytics · Jan 17, 2019 · 02a7432 · 02a7432
1 parent 861d15d
commit 02a7432
Show file tree

Hide file tree

Showing 9 changed files with 65 additions and 0 deletions.
diff --git a/docs/images/Bildschirmfoto 2019-01-17 um 09.56.32.png b/docs/images/Bildschirmfoto 2019-01-17 um 09.56.32.png
diff --git a/docs/images/batch_size.png b/docs/images/batch_size.png
diff --git a/docs/images/epochs.png b/docs/images/epochs.png
diff --git a/docs/images/execution_mode.png b/docs/images/execution_mode.png
diff --git a/docs/images/output_directory.png b/docs/images/output_directory.png
diff --git a/docs/images/provide_dataset.png b/docs/images/provide_dataset.png
diff --git a/docs/images/random_seed.png b/docs/images/random_seed.png
diff --git a/docs/images/select_model.png b/docs/images/select_model.png
diff --git a/docs/source/run_biokeen.rst b/docs/source/run_biokeen.rst
@@ -0,0 +1,65 @@
+Run BioKEEN
+==========
+
+Configure an experiment through the CLI and train and evaluate a model
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To get an overview of the avilable commands in BioKEEN, please run:
+
+.. code-block:: python
+
+   biokeen
+
+
+**Step 1**: Start CLI
+
+.. code-block:: python
+
+   biokeen start
+
+**Step 2**: Provide the dataset
+
+.. image:: ../images/provide_dataset.png
+   :target: pageapplet/index.html
+
+
+**Step 3**: Specify execution mode
+
+.. image:: ../images/execution_mode.png
+   :target: pageapplet/index.html
+
+**Step 4**: Select KGE model
+
+.. image:: ../images/select_model.png
+   :target: pageapplet/index.html
+
+**Step 5**: Specify model dependent hyper-parameters
+
+**Step 6**: Specify the batch-size
+.. image:: ../images/batch_size.png
+   :target: pageapplet/index.html
+
+**Step 7**: Specify the number of training epochs
+.. image:: ../images/epochs.png
+   :target: pageapplet/index.html
+
+**Step 8**: Specify whether to evaluate the model
+.. image:: ../images/epochs.png
+   :target: pageapplet/index.html
+
+**Step 9**: Specify whether to evaluate the model
+.. image:: ../images/epochs.png
+   :target: pageapplet/index.html
+
+**Step 10**: Provide a random seed
+.. image:: ../images/random_seed.png
+   :target: pageapplet/index.html
+
+**Step 12**: Specify preferred device
+.. image:: ../images/random_seed.png
+   :target: pageapplet/index.html
+
+**Step 13**: Specify the path to the output directory
+.. image:: ../images/output_directory.png
+   :target: pageapplet/index.html
+