Skip to content

Commit

Permalink
Fix minors errors on docs
Browse files Browse the repository at this point in the history
Signed-off-by: Javier Gil Aviles <[email protected]>
  • Loading branch information
Javgilavi committed Dec 16, 2024
1 parent d842bc5 commit a8b0425
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,15 @@ Within the *SustainML Architecture*, a ``Node`` refers to each one of the softwa
a particular task, conforms a single executable unit and can be locally or remotely deployed.
This decoupling and modularity can be achieved thanks to the underlying `eProsima Fast DDS middleware <https://www.eprosima.com/index.php/products-all/eprosima-fast-dds>`_.

* :ref:`frontend`

In the architecture, the ``Front-End`` acts as the interface between the user and the *SustainML Framework*.
The Front-End is responsible for collecting the user requirements and constraints, sending them to the Back-End and give feedback of the intermediate and final results when available:

The ``Back-End`` is composed of two main entities.
* :ref:`frontend`

* :ref:`orchestrator`
The ``Back-End`` is composed of two main entities:

The ``Orchestrator Node`` that controls the execution of the task and nourishes data to the Front-End.
* The :ref:`orchestrator` that controls the execution of the task and nourishes data to the Front-End.
* The :ref:`module_nodes` that specialize in particular tasks of the solution.

.. _module_nodes:

Expand All @@ -52,12 +51,12 @@ Module Nodes

And the different ``Module Nodes`` that specializes in a particular task of the solution:

* :ref:`mlmodelmetadata_node`
* :ref:`mlmodelprovider_node`
* :ref:`appreqs_node`
* :ref:`carbontracker_node`
* :ref:`hwconstraints_node`
* :ref:`mlmodelmetadata_node`
* :ref:`mlmodelprovider_node`
* :ref:`hwprovider_node`
* :ref:`carbontracker_node`


.. toctree::
Expand Down
18 changes: 10 additions & 8 deletions sustainml_docs/rst/installation/framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@ The following command also builds and installs the SustainML framework and all i
pip3 install -U colcon-common-extensions vcstool && \
curl -fsSL https://ollama.com/install.sh | sh && ollama pull llama3 && cd ~/SustainML/SustainML_ws && \
wget https://raw.githubusercontent.com/eProsima/SustainML-Framework/main/sustainml.repos && \
vcs import src < sustainml.repos && \
vcs import src < sustainml.repos && cd ~/SustainML/SustainML_ws/src/sustainml_lib && \
git submodule update --init --recursive && \
pip3 install -r ~/SustainML/SustainML_ws/src/sustainml_lib/sustainml_modules/requirements.txt && \
colcon build && \
cd ~/SustainML/SustainML_ws && colcon build && \
source ~/SustainML/SustainML_ws/install/setup.bash
.. group-tab:: MacOS
Expand All @@ -91,10 +91,10 @@ The following command also builds and installs the SustainML framework and all i
pip3 install -U colcon-common-extensions vcstool && \
curl -fsSL https://ollama.com/install.sh | sh && ollama pull llama3 && cd ~/SustainML/SustainML_ws && \
wget https://raw.githubusercontent.com/eProsima/SustainML-Framework/macos-compilation/sustainml.repos && \
vcs import src < sustainml.repos && \
vcs import src < sustainml.repos && cd ~/SustainML/SustainML_ws/src/sustainml_lib && \
git submodule update --init --recursive && \
pip3 install -r ~/SustainML/SustainML_ws/src/sustainml_lib/sustainml_modules/requirements.txt && \
colcon build --packages-up-to sustainml --cmake-args -DCMAKE_CXX_STANDARD=17 \
cd ~/SustainML/SustainML_ws && colcon build --packages-up-to sustainml --cmake-args -DCMAKE_CXX_STANDARD=17 \
-DQt5_DIR=/usr/local/opt/qt5/lib/cmake/Qt5 && \
cd ~/SustainML/SustainML_ws/install && source setup.bash
Expand All @@ -114,28 +114,30 @@ The following script runs all of them:
.. code-block:: bash
bash -c " \
cd ~/SustainML/SustainML_ws/src/sustainml_lib/sustainml_modules/sustainml_modules && \
cd ~/SustainML/SustainML_ws/build/sustainml_modules/lib/sustainml_modules; \
python3 sustainml-wp1/app_requirements_node.py & \
python3 sustainml-wp1/ml_model_metadata_node.py & \
python3 sustainml-wp1/ml_model_provider_node.py & \
python3 sustainml-wp2/hw_constraints_node.py & \
python3 sustainml-wp2/hw_resources_provider_node.py & \
python3 sustainml-wp3/carbon_footprint_node.py & \
sustainml"
python3 sustainml-wp5/backend_node.py & \
sustainml”
.. group-tab:: MacOS
.. code-block:: bash
bash -c " \
cd ~/SustainML/SustainML_ws/src/sustainml_lib/sustainml_modules/sustainml_modules
cd ~/SustainML/SustainML_ws/build/sustainml_modules/lib/sustainml_modules; \
python3 sustainml-wp1/app_requirements_node.py & \
python3 sustainml-wp1/ml_model_metadata_node.py & \
python3 sustainml-wp1/ml_model_provider_node.py & \
python3 sustainml-wp2/hw_constraints_node.py & \
python3 sustainml-wp2/hw_resources_provider_node.py & \
python3 sustainml-wp3/carbon_footprint_node.py & \
sustainml"
python3 sustainml-wp5/backend_node.py & \
sustainml”
.. note::

Expand Down

0 comments on commit a8b0425

Please sign in to comment.