Skip to content

Commit

Permalink
Update and rename docs/concepts.rst to architecture_methodology_compo… (
Browse files Browse the repository at this point in the history
#488)

* Update and rename docs/concepts.rst to architecture_methodology_components.rst

Changed the title, image and repositioned some of the text.

Signed-off-by: Jonita Ruiter <[email protected]>

* Add files via upload

Signed-off-by: Jonita Ruiter <[email protected]>

---------

Signed-off-by: Jonita Ruiter <[email protected]>
  • Loading branch information
JonitaRuiter authored Dec 12, 2023
1 parent 6b35fd4 commit 15f1f0f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/concepts.rst → architecture_methodology_components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@
.. _concepts:

Concepts
Architecture, Methodology, and Components
========

Understanding the architecture of OpenSTEF will help you gain insight on how to use this software package
and better understand the rest of the documentation.

Software architecture
---------------------
OpenSTEF is set up as a Python package that performs machine learning in order to forecast energy loads on the energy grid.

.. image:: https://user-images.githubusercontent.com/25053215/184536369-ed608e86-1ea8-4c16-8c6a-5eaeb145eedf.png
:width: 800
.. image:: https://github.com/OpenSTEF/openstef/blob/a3abd78212248ee71fcfe182894c04e2df6dd1df/docs/software_arch.png
:width: 830

OpenSTEF is set up as a Python package that performs machine learning in order to forecast energy loads on the energy grid.
It contains:
OpenSTEF contains:

* **Prediction job**: input configuration for a task and/or pipeline
(e.g. train an XGB model for a certain location).
Expand Down

0 comments on commit 15f1f0f

Please sign in to comment.