From e0528e25781abd9533720a3178acb44d3f035739 Mon Sep 17 00:00:00 2001 From: azouaoui-cv Date: Fri, 26 Apr 2024 11:59:34 +0200 Subject: [PATCH] (tutorial) fix README.rst syntax; --- tutorial/README.rst | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/tutorial/README.rst b/tutorial/README.rst index 91c3774..253be81 100644 --- a/tutorial/README.rst +++ b/tutorial/README.rst @@ -1,30 +1,34 @@ MLXP Tutorial -==== +------------- This page presents the main functionalities of MLXP through a tutorial. See the following page for more detailed information: -`Tutorial ` +- `Tutorial `__ Requirements -^^^^^^^^^^^^ -The minimal working example requires you to install `MLXP` and `torch`. -You may find a requirements file (`requirements.txt`) -which you can use in a dedicated virtual environment: +------------ + +The minimal working example requires you to install ``MLXP`` and +``torch``. You may find a requirements file (``requirements.txt``) which +you can use in a dedicated virtual environment: + +.. code:: console -.. code-block:: console $ pip install -r requirements.txt Usage -^^^^^ -To generate the `./logs/`, simply run: +----- -.. code-block:: console - $ python main.py +To generate the ``./logs/``, simply run: -Once the logs have been generated, to read, query and filter results, simply run: +.. code:: console -.. code-block:: console - $ python read.py + $ python main.py + +Once the logs have been generated, to read, query and filter results, +simply run: +.. code:: console + $ python read.py