Skip to content

Commit

Permalink
provided server examples in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nidhal baccouri committed Jun 18, 2021
1 parent 5b0f35e commit 7178c8e
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,24 @@ Igel uses `FastAPI <https://fastapi.tiangolo.com/>`_ for creating the REST serve
framework
and `uvicorn <https://www.uvicorn.org/>`_ to run it under the hood.

----------------------------------------------------------------------------------------------------------


Use igel from python (instead of terminal)
###########################################

- Alternatively, you can also write code if you want to:

.. code-block:: python
from igel import Igel
Igel(cmd="fit", data_path="path_to_your_dataset", yaml_path="path_to_your_yaml_file")
"""
check the examples folder for more
"""
----------------------------------------------------------------------------------------------------------


Interactive Mode
Expand Down

0 comments on commit 7178c8e

Please sign in to comment.