Skip to content

Commit

Permalink
docs(ex3EKF): ddd reference to Original Ex3EKF env description
Browse files Browse the repository at this point in the history
This commit updates the documentation to include the original source
where the Ex3EKF environment was first described. This addition provides
readers with the context and foundational literature necessary to
understand the development and application of the Ex3EKF environment
more comprehensively.
  • Loading branch information
rickstaa committed Feb 14, 2024
1 parent f2a097b commit a42922f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion stable_gym/envs/classic_control/ex3_ekf/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ex3EKF gymnasium environment

Check failure on line 1 in stable_gym/envs/classic_control/ex3_ekf/README.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] stable_gym/envs/classic_control/ex3_ekf/README.md#L1

TypeError: Cannot read properties of undefined (reading 'mathFlowInside')
Raw output
   1:1  error    TypeError: Cannot read properties of undefined (reading 'mathFlowInside')

A gymnasium environment for a noisy master-slave system. This environment can be used to train an RL-based stationary Kalman filter.
A gymnasium environment for a noisy master-slave system. This environment can be used to train an RL-based stationary Kalman filter. First presented by [Wu et al. 2023](https://www.sciencedirect.com/science/article/pii/S0005109823001528).

## Observation space

Expand Down
4 changes: 3 additions & 1 deletion stable_gym/envs/classic_control/ex3_ekf/ex3_ekf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class Ex3EKF(gym.Env):
Description:
The goal of the agent in the Ex3EKF environment is to act in such a way that
estimator perfectly estimated the original noisy system. By doing this it serves
as a RL based stationary Kalman filter.
as a RL based stationary Kalman filter. First presented by `Wu et al. 2023`_.
Observation:
**Type**: Box(4)
Expand Down Expand Up @@ -64,6 +64,8 @@ class Ex3EKF(gym.Env):
t (float): The current time step.
dt (float): The environment step size. Also available as :attr:`.tau`.
sigma (float): The variance of the system noise.
.. _`Wu et al. 2023`: https://www.sciencedirect.com/science/article/pii/S0005109823001528
""" # noqa: E501

def __init__(
Expand Down

0 comments on commit a42922f

Please sign in to comment.