Skip to content

Commit

Permalink
Update tutorial version and run precommit.
Browse files Browse the repository at this point in the history
  • Loading branch information
@javiarrobas
javiarrobas committed Sep 3, 2024
1 parent 96de92a commit 4e361a0
Showing 1 changed file with 17 additions and 19 deletions.
36 changes: 17 additions & 19 deletions web/04_training.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,28 @@ permalink: /training/
hero_height: is-fullwidth
---

The best way to learn BOPTEST is by using it!
Here you can find a list with links to training material (tutorials, workshops, presentations, etc.) that you may want to use for learning.
We provide a small description for each so you know what material suits you best.
The best way to learn BOPTEST is by using it!
Here you can find a list with links to training material (tutorials, workshops, presentations, etc.) that you may want to use for learning.
We provide a small description for each so you know what material suits you best.

# User Tutorials and Workshops

#### RLEM2023 Workshop: Introduction to the BOPTEST Framework

- 🗓️ **Last updated**: 2023/11/13
- 🗓️ **Last updated**: 2024/09/03

- ⚙️ **Compatible with**: `BOPTEST-v0.5.0`, `BOPTEST-Gym-v0.5.0`
- ⚙️ **Compatible with**: `BOPTEST-v0.6.0`, `BOPTEST-Gym-v0.6.0`

- 🔗 **Links**: <a href="https://colab.research.google.com/github/ibpsa/project1-boptest/blob/master/docs/workshops/RlemWorkshop_20231112/Introduction_to_the_BOPTEST_framework.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>, [presentation BOPTEST project](https://github.com/ibpsa/project1-boptest/blob/master/docs/workshops/RlemWorkshop_20231112/presentations/BOPTEST_Overview_RLEM23_20231112.pptx.pdf), [presentation MPC and RL examples in BOPTEST](https://github.com/ibpsa/project1-boptest/blob/master/docs/workshops/RlemWorkshop_20231112/presentations/Example_Development_and_Evaluation_RLEM23_20231112.pdf)

- ⏰ **Duration**: 3.5 hours

- 📝 **Brief description**: This is an introductory, hands-on tutorial to guide you through usage of the BOPTEST framework and its Gym interface for performance benchmarking of control algorithms. This one is similar to the one of BS2023 workshop but is more extensive and elaborates further in the BOPTEST native API and its Gym interface.
- 📝 **Brief description**: This is an introductory, hands-on tutorial to guide you through usage of the BOPTEST framework and its Gym interface for performance benchmarking of control algorithms. This one is similar to the one of BS2023 workshop but is more extensive and elaborates further in the BOPTEST native API and its Gym interface.
The tutorial is split into four main parts:

1. Presentation 1: Introduction to the BOPTEST project, goals and approach
1. Presentation 1: Introduction to the BOPTEST project, goals and approach
2. Exercise 1: Introductory hands-on tutorial on the software
3. Presentation 2: MPC and RL examples in BOPTEST
3. Presentation 2: MPC and RL examples in BOPTEST
4. Exercise 2: Learning BOPTEST-Gym: the OpenAI-Gym interface of BOPTEST

#### BS2023 Workshop: Introduction to the BOPTEST Framework
Expand All @@ -39,10 +39,10 @@ The tutorial is split into four main parts:

- ⏰ **Duration**: 1.5 hours

- 📝 **Brief description**: This is an introductory, hands-on tutorial to guide you through the BOPTEST framework and its Gym interface for performance benchmarking of control algorithms. The first exercise is common to the one from the BS2021 workshop but the second exercise explains BOPTEST-Gym instead of diving further into the BOPTEST API. The overall time is also shorter. Therefore, this tutorial gives a faster (but less deep) intro to both BOPTEST and BOPTEST-Gym.
- 📝 **Brief description**: This is an introductory, hands-on tutorial to guide you through the BOPTEST framework and its Gym interface for performance benchmarking of control algorithms. The first exercise is common to the one from the BS2021 workshop but the second exercise explains BOPTEST-Gym instead of diving further into the BOPTEST API. The overall time is also shorter. Therefore, this tutorial gives a faster (but less deep) intro to both BOPTEST and BOPTEST-Gym.
The tutorial is split into three main parts:

1. Presentation 1: Introduction to the BOPTEST project, goals and approach
1. Presentation 1: Introduction to the BOPTEST project, goals and approach
2. Exercise 1: Introduction to the BOPTEST API and sample controller testing
3. Exercise 2: Learning BOPTEST-Gym: the OpenAI-Gym interface of BOPTEST

Expand All @@ -56,11 +56,11 @@ The tutorial is split into three main parts:

- ⏰ **Duration**: 2.5 hours

- 🎥 **Video**: An explanatory video of this tutorial can be found [here](https://drive.google.com/file/d/1lvCVQef_kctwCagA5QOVj7QljHQ1xKUQ/view?usp=sharing) for the CCAI2022 Summer School on August 18, 2022. The video starts with a one-hour lecture on the application of machine learning in buildings. The part of BOPTEST-Gym follows right after and lasts for 1.5 hours. Please note that the software version used in the video is `BOPTEST-v0.2.0.` The framework and tutorial have been updated since then so you may notice slight differences in the content and interface. However, the main concepts and explanation behind remains the same.
- 🎥 **Video**: An explanatory video of this tutorial can be found [here](https://drive.google.com/file/d/1lvCVQef_kctwCagA5QOVj7QljHQ1xKUQ/view?usp=sharing) for the CCAI2022 Summer School on August 18, 2022. The video starts with a one-hour lecture on the application of machine learning in buildings. The part of BOPTEST-Gym follows right after and lasts for 1.5 hours. Please note that the software version used in the video is `BOPTEST-v0.2.0.` The framework and tutorial have been updated since then so you may notice slight differences in the content and interface. However, the main concepts and explanation behind remains the same.

- 📝 **Brief description**: This is an introductory, hands-on tutorial to guide you through the main concepts of Reinforcement Learning (RL) for controlling Heating, Ventilation and Air Conditioning (HVAC) systems for buildings.
It applies RL to a building emulator from BOPTEST using its BOPTEST-Gym interface.
Compared to other tutorials, this one dives focuses more into concepts of RL and elaborates further on the BOPTEST-Gym interface.
Compared to other tutorials, this one dives focuses more into concepts of RL and elaborates further on the BOPTEST-Gym interface.
The tutorial has the following parts:

1. Background on RL in buildings
Expand All @@ -74,13 +74,13 @@ The tutorial has the following parts:

- ⚙️ **Compatible with**: `BOPTEST-v0.4.0`

- 🔗 **Links**: <a href="https://colab.research.google.com/github/ibpsa/project1-boptest/blob/master/docs/workshops/BS21Workshop_20210831/Introduction_to_the_BOPTEST_framework.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>, [presentation BOPTEST project](https://github.com/ibpsa/project1-boptest/blob/master/docs/workshops/BS21Workshop_20210831/presentations/Introduction%20to%20the%20BOPTEST%20project.pdf), [presentation MPC example in BOPTEST](https://github.com/ibpsa/project1-boptest/blob/master/docs/workshops/BS21Workshop_20210831/presentations/Example%20MPC%20in%20BOPTEST.pdf).
- 🔗 **Links**: <a href="https://colab.research.google.com/github/ibpsa/project1-boptest/blob/master/docs/workshops/BS21Workshop_20210831/Introduction_to_the_BOPTEST_framework.ipynb" target="_parent"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>, [presentation BOPTEST project](https://github.com/ibpsa/project1-boptest/blob/master/docs/workshops/BS21Workshop_20210831/presentations/Introduction%20to%20the%20BOPTEST%20project.pdf), [presentation MPC example in BOPTEST](https://github.com/ibpsa/project1-boptest/blob/master/docs/workshops/BS21Workshop_20210831/presentations/Example%20MPC%20in%20BOPTEST.pdf).

- ⏰ **Duration**: 3.5 hours

- 📝 **Brief description**: This is an introductory, hands-on tutorial to guide you through the BOPTEST framework for performance benchmarking of control algorithms. The tutorial is split into four main parts:

1. Presentation 1: Introduction to the BOPTEST project, goals and approach
1. Presentation 1: Introduction to the BOPTEST project, goals and approach
2. Exercise 1: Introduction to the BOPTEST API and sample controller testing
3. Presentation 2: Example development and evaluation of an MPC controller
4. Exercise 2: Improving controller performance and reporting results
Expand All @@ -98,8 +98,6 @@ tutorial1_developer/BOPTEST_Tutorial1_developer_20230416.pdf)

- 📝 **Brief description**: The purpose of this tutorial is to provide basic introduction of the BOPTEST framework and associated software components to potential test case developers and controller testers. Therefore, the tutorial is split into three main parts:

1. Software requirements
2. Test case development
1. Software requirements
2. Test case development
3. Test case interaction


0 comments on commit 4e361a0

Please sign in to comment.