Skip to content
This repository has been archived by the owner on Sep 7, 2022. It is now read-only.

Commit

Permalink
Update run_biokeen.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
cthoyt committed Jan 17, 2019
1 parent 434fb74 commit fb61564
Showing 1 changed file with 29 additions and 35 deletions.
64 changes: 29 additions & 35 deletions docs/source/run_biokeen.rst
Original file line number Diff line number Diff line change
@@ -1,65 +1,59 @@
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:
----------------------------------------------------------------------
To get an overview of the available commands in BioKEEN, please run:

.. code-block:: python
.. code-block:: sh
biokeen
**Step 1**: Start CLI

.. code-block:: python
Step 1: Start CLI
~~~~~~~~~~~~~~~~~
.. code-block:: sh
biokeen start
**Step 2**: Provide the dataset
Step 2: Provide the dataset
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. image:: ../images/provide_dataset.png
:target: pageapplet/index.html


**Step 3**: Specify execution mode

Step 3: Specify execution mode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: ../images/execution_mode.png
:target: pageapplet/index.html

**Step 4**: Select KGE model

Step 4: Select KGE model
~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: ../images/select_model.png
:target: pageapplet/index.html

**Step 5**: Specify model dependent hyper-parameters
Step 5: Specify model dependent hyper-parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**Step 6**: Specify the batch-size
Step 6: Specify the batch-size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: ../images/batch_size.png
:target: pageapplet/index.html

**Step 7**: Specify the number of training epochs
Step 7: Specify the number of training epochs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: ../images/epochs.png
:target: pageapplet/index.html

**Step 8**: Specify whether to evaluate the model
Step 8: Specify whether to evaluate the model
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: ../images/epochs.png
:target: pageapplet/index.html

**Step 9**: Specify whether to evaluate the model
Step 9: Specify whether to evaluate the model
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: ../images/epochs.png
:target: pageapplet/index.html

**Step 10**: Provide a random seed
Step 10: Provide a random seed
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: ../images/random_seed.png
:target: pageapplet/index.html

**Step 12**: Specify preferred device
Step 12: Specify preferred device
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: ../images/random_seed.png
:target: pageapplet/index.html

**Step 13**: Specify the path to the output directory
Step 13: Specify the path to the output directory
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: ../images/output_directory.png
:target: pageapplet/index.html

0 comments on commit fb61564

Please sign in to comment.