From 988f51fd3f6ede39dd1b4ff94a7c280a2c5ccfea Mon Sep 17 00:00:00 2001 From: Mo8it Date: Tue, 8 Feb 2022 23:45:30 +0100 Subject: [PATCH] Add short description to all environments --- README.adoc | 3 +-- src/RL/Envs/COMCompassEnv.jl | 4 ++++ src/RL/Envs/LocalCOMEnv.jl | 4 ++++ src/RL/Envs/LocalCOMWithAdditionalShapeRewardEnv.jl | 5 +++++ src/RL/Envs/LocalCOMWithAdditionalShapeRewardEnv2.jl | 5 +++++ src/RL/Envs/NearestNeighborEnv.jl | 4 ++++ src/RL/Envs/OriginCompassEnv.jl | 4 ++++ src/RL/Envs/OriginEnv.jl | 4 ++++ 8 files changed, 31 insertions(+), 2 deletions(-) diff --git a/README.adoc b/README.adoc index 3853a2b..1f0f7e2 100644 --- a/README.adoc +++ b/README.adoc @@ -108,8 +108,7 @@ Run a reinforcement learning process and return the environment helper and the t env_helper, rl_dir = run_rl(ENVTYPE) ---- -`ENVTYPE` has to be replaced by one of the environments named after the file names in the directory `ReCo.jl/RL/Envs`, for example: `LocalCOMEnv`. A description of an environment is included at the beginning of the corresponding file. -//TODO: Descriptions of envs +`ENVTYPE` has to be replaced by one of the environments named after the file names in the directory `ReCo.jl/RL/Envs`, for example: `LocalCOMEnv`. A short description of an environment is included at the beginning of the corresponding file. The documentation of `run_rl` includes all possible optional arguments. diff --git a/src/RL/Envs/COMCompassEnv.jl b/src/RL/Envs/COMCompassEnv.jl index a42e020..30cc405 100644 --- a/src/RL/Envs/COMCompassEnv.jl +++ b/src/RL/Envs/COMCompassEnv.jl @@ -1,3 +1,7 @@ +""" +This environment corresponds to the center of mass with a compass strategy. +""" + using ..ReCo: ReCo struct COMCompassEnv <: Env diff --git a/src/RL/Envs/LocalCOMEnv.jl b/src/RL/Envs/LocalCOMEnv.jl index fd13813..edb0321 100644 --- a/src/RL/Envs/LocalCOMEnv.jl +++ b/src/RL/Envs/LocalCOMEnv.jl @@ -1,3 +1,7 @@ +""" +This environment corresponds to the local center of mass strategy. +""" + using ..ReCo: ReCo struct LocalCOMEnv <: Env diff --git a/src/RL/Envs/LocalCOMWithAdditionalShapeRewardEnv.jl b/src/RL/Envs/LocalCOMWithAdditionalShapeRewardEnv.jl index e4fc279..b885eea 100644 --- a/src/RL/Envs/LocalCOMWithAdditionalShapeRewardEnv.jl +++ b/src/RL/Envs/LocalCOMWithAdditionalShapeRewardEnv.jl @@ -1,3 +1,8 @@ +""" +This environment corresponds to the local center of mass strategy with an additional shape reward term. +The minimization variable of the additional reward term is the individual elliptical distance of a particle. +""" + using ..ReCo: ReCo struct LocalCOMWithAdditionalShapeRewardEnv <: Env diff --git a/src/RL/Envs/LocalCOMWithAdditionalShapeRewardEnv2.jl b/src/RL/Envs/LocalCOMWithAdditionalShapeRewardEnv2.jl index dc9b429..63cace9 100644 --- a/src/RL/Envs/LocalCOMWithAdditionalShapeRewardEnv2.jl +++ b/src/RL/Envs/LocalCOMWithAdditionalShapeRewardEnv2.jl @@ -1,3 +1,8 @@ +""" +This environment corresponds to the local center of mass strategy with an additional shape reward term. +The minimization variable of the additional reward term is the absolute difference of the current value of κ to the goal value. +""" + using ..ReCo: ReCo struct LocalCOMWithAdditionalShapeRewardEnv2 <: Env diff --git a/src/RL/Envs/NearestNeighborEnv.jl b/src/RL/Envs/NearestNeighborEnv.jl index c48cfc6..d5c048a 100644 --- a/src/RL/Envs/NearestNeighborEnv.jl +++ b/src/RL/Envs/NearestNeighborEnv.jl @@ -1,3 +1,7 @@ +""" +This environment corresponds to the nearest neighbor strategy. +""" + using ..ReCo: ReCo struct NearestNeighborEnv <: Env diff --git a/src/RL/Envs/OriginCompassEnv.jl b/src/RL/Envs/OriginCompassEnv.jl index c6fd195..b02b0be 100644 --- a/src/RL/Envs/OriginCompassEnv.jl +++ b/src/RL/Envs/OriginCompassEnv.jl @@ -1,3 +1,7 @@ +""" +This environment corresponds to the strategy of the origin of the coordinates system with a compass. +""" + using ..ReCo: ReCo struct OriginCompassEnv <: Env diff --git a/src/RL/Envs/OriginEnv.jl b/src/RL/Envs/OriginEnv.jl index 429f8e2..c0084d9 100644 --- a/src/RL/Envs/OriginEnv.jl +++ b/src/RL/Envs/OriginEnv.jl @@ -1,3 +1,7 @@ +""" +This environment corresponds to the strategy of the origin of the coordinates system. +""" + using ..ReCo: ReCo struct OriginEnv <: Env