Commit 2d9f82fe authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI
Browse files

[general][doc] more in hands on tutorial

parent c8982be5
Pipeline #24653 passed with stages
in 4 minutes and 40 seconds
......@@ -192,7 +192,7 @@ Luckily, these are all already created for us!
Running the Iris LDA Experiment
===============================
Now that we understand what we're doing (more or less), let's get our hands dirty running the pre-made Iris LDA experiment. To do so, we'll be using the ``beat`` cli tool from the ``beat.cmdline`` package.
Now that we understand what we're doing (more or less), let's get our hands dirty running the pre-made Iris LDA experiment. To do so, we'll be using the BEAT command line tool from the ``beat.cmdline`` package.
.. warning::
Remember to run shell commands in the parent directory of your prefix!
......@@ -246,10 +246,10 @@ You should be seeing two plots, the ROC and scores distribution:
Debugging the Iris LDA Experiment
=================================
There are a couple things to keep in mind when debugging your experiments:
There are a couple of things to keep in mind when debugging your experiments:
#. The BEAT cache system
#. The availability of normal Python debugging strategies
#. The BEAT cache system.
#. The availability of normal Python debugging strategies.
The Cache System
----------------
......@@ -261,7 +261,7 @@ There is a subfolder in your prefix called ``cache``. This folder holds all the
* Changing a database means that all experiments ran using that database cannot use any of their caches.
* Changing an analyzer of an experiment means that only the last step will have to be re-ran.
.. note:: Please note that the root folder of the database is not a part of information used for producing the hash of the database block. Therefore if the only modification in a database block is changing its root folder, beat will use the previous cach data available. You need to clear the cache manually to make sure that the new root folder is accessable by beat. for more information about the data used for making the hashes of each block please refer to the `hash.py <https://gitlab.idiap.ch/beat/beat.core/blob/master/beat/core/hash.py>`_ from beat.core.
.. note:: Please note that the root folder of the database is not a part of information used for producing the hash of the database block. Therefore if the only modification in a database block is changing its root folder, BEAT will use the previous cach data available. You need to clear the cache manually to make sure that the new root folder is accessable by beat. for more information about the data used for making the hashes of each block please refer to the `hash.py <https://gitlab.idiap.ch/beat/beat.core/blob/master/beat/core/hash.py>`_ from beat.core.
......@@ -345,7 +345,7 @@ Change the "User" field from "test" to "tutorial" (or your own name), and change
Click on your Iris Means experiment's name to go into the Experiment Editor for that experiment. We are going to change this copied experiment from using LDA as its algorithm to using our means algorithm. These two algorithms are already created - ``test/means_training/1`` and ``test/means_testing/1``.
.. note:: Please see the "Experiment Editor" documentation section for information on what constitutes the editor.
.. note:: Please see the :ref:`experiment-editor` documentation section for information on what constitutes the editor.
In the toolchain window, click on the `training_alg` block to open the block editor for that block. Under the toolchain window, change the selected algorithm for the `training_alg` block under the "Algorithm" select box from ``test/iris_training/1`` to ``test/means_training/1``.
......@@ -412,7 +412,7 @@ Go to your ``beat.editor`` browser tab. Click on the `toolchains` button at the
Do the same we did for the experiment: click the `Clone` button and change the "User" & "Name" fields from "test" and "iris" to "tutorial" and "iris_advanced", respectively. Click `Create` to save the toolchain, and click on the new toolchain's name to open up the Toolchain Editor for this object.
.. note:: Please see the "Toolchain Editor" documentation section for information on what constitutes the editor.
.. note:: Please see the :ref:`toolchain-editor` documentation section for information on what constitutes the editor.
Now we will add the preprocessor blocks to the toolchain. Do the following steps:
......@@ -436,7 +436,7 @@ Click the `New` button in the top right of the list to pop up the modal for crea
Click `Create` to create the new algorithm, ``tutorial/iris_preprocessor/1``, at the top of your algorithms list. Click on the new algorithm's name to enter the Algorithm Editor for this algorithm.
.. note:: Please see the "Algorithm Editor" documentation section for information on what constitutes the editor.
.. note:: Please see the :ref:`algorithm-editor` documentation section for information on what constitutes the editor.
Our preprocessor algorithm takes in a sample (set of 4 measurements), rounds the measurements, and returns the rounded sample. This means that the algorithm will have 1 group with 1 input and 1 output. Do the following steps:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment