Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update and rename docs/concepts.rst to architecture_methodology_compo… #488

Merged
merged 2 commits into from
Dec 12, 2023
Merged

Update and rename docs/concepts.rst to architecture_methodology_compo… #488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef2e7fd
Update and rename docs/concepts.rst to architecture_methodology_compo…
JonitaRuiter Dec 11, 2023
c8b5d14
Add files via upload
JonitaRuiter Dec 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/concepts.rst → architecture_methodology_components.rst
View file
Open in desktop
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
3 changes: 3 additions & 0 deletions docs/software_arch.png.license
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2017-2023 Contributors to the OpenSTEF project <[email protected]>

SPDX-License-Identifier: MPL-2.0
Loading