Skip to content

Commit

Permalink
(tutorial) fix README.rst syntax;
Browse files Browse the repository at this point in the history
  • Loading branch information
azouaoui-cv committed Apr 26, 2024
1 parent 1bbd47e commit e0528e2
Showing 1 changed file with 18 additions and 14 deletions.
32 changes: 18 additions & 14 deletions tutorial/README.rst
Original file line number Diff line number Diff line change
@@ -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 <https://inria-thoth.github.io/mlxp/tutorial.html>`
- `Tutorial <https://inria-thoth.github.io/mlxp/tutorial.html>`__

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

0 comments on commit e0528e2

Please sign in to comment.