From a8b0425346d2e440098a279463359135e9a703ca Mon Sep 17 00:00:00 2001 From: Javier Gil Aviles Date: Mon, 16 Dec 2024 16:31:54 +0100 Subject: [PATCH] Fix minors errors on docs Signed-off-by: Javier Gil Aviles --- .../architecture/architecture.rst | 15 +++++++-------- sustainml_docs/rst/installation/framework.rst | 18 ++++++++++-------- 2 files changed, 17 insertions(+), 16 deletions(-) diff --git a/sustainml_docs/rst/developer_manual/architecture/architecture.rst b/sustainml_docs/rst/developer_manual/architecture/architecture.rst index c2b81fe..6ecffcc 100644 --- a/sustainml_docs/rst/developer_manual/architecture/architecture.rst +++ b/sustainml_docs/rst/developer_manual/architecture/architecture.rst @@ -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 `_. -* :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: @@ -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:: diff --git a/sustainml_docs/rst/installation/framework.rst b/sustainml_docs/rst/installation/framework.rst index 424cb7d..afa22aa 100644 --- a/sustainml_docs/rst/installation/framework.rst +++ b/sustainml_docs/rst/installation/framework.rst @@ -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 @@ -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 @@ -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::