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.

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

(v2.2.6) DRL_battery.py configuration improvement with JSON configuration mode #299

Merged
merged 16 commits into from
Mar 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion docs/source/_templates/shields.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
</p>
<p align="center">
<a href="https://github.com/ugr-sail/sinergym/releases">
<img alt="Github latest release" src="https://img.shields.io/github/release-date/ugr-sail/sinergym" />
Expand Down
24 changes: 19 additions & 5 deletions docs/source/pages/deep-reinforcement-learning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ How use
You can try your own experiments and benefit from this functionality.
`sinergym/scripts/DRL_battery.py <https://github.com/ugr-sail/sinergym/blob/main/scripts/DRL_battery.py>`__
is a example code to use it. You can use ``DRL_battery.py`` directly from
your local computer specifying ``--tensorboard`` flag in execution.
your local computer or using Google Cloud Platform.

The most **important information** you must keep in mind when you try
your own experiments are:
Expand All @@ -179,13 +179,27 @@ your own experiments are:
specify train ``timesteps``, ``callbacks`` and ``log_interval``
as we commented in type algorithms (On and Off Policy).

* ``DRL_battery.py`` requires some **extra arguments** to being
executed like ``-env`` and ``-ep``.

* You can execute **Curriculum Learning**, you only have to
add ``--model`` field with a valid model path, this script
add model field with a valid model path, this script
will load the model and execute to train.

``DRL_battery.py`` has a unique parameter to be able to execute it; ``-conf``.
This parameter is a str to indicate the JSON file in which there are allocated
all information about the experiment you want to execute. You can see the
JSON structure example in `sinergym/scripts/DRL_battery_example.json <https://github.com/ugr-sail/sinergym/blob/main/scripts/DRL_battery_example.json>`__:

* The **obligatory** parameters are: environment, episodes,
algorithm (and parameters of the algorithm which don't have
default values).

* The **optional** parameters are: All environment parameters (if it is specified
will be overwrite the default environment value) seed, model to load (before training),
experiment ID, wrappers to use (respecting the order), training evaluation,
tensorboard functionality and cloud options.

* The name of the fields must be like in example mentioned. Otherwise, the experiment
will return an error.

****************
Mlflow
****************
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
autopep8
eppy
gymnasium
isort[requirements_deprecated_finder,pipfile_deprecated_finder]
isort
numpy
opyplus
pandas
Expand Down
Loading