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

Improve documentation of MotionCheck Behaviour. #86

Open
chenkins opened this issue Nov 20, 2024 · 0 comments · May be fixed by #87
Open

Improve documentation of MotionCheck Behaviour. #86

chenkins opened this issue Nov 20, 2024 · 0 comments · May be fixed by #87
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@chenkins
Copy link
Contributor

chenkins commented Nov 20, 2024

Target

  • Improve documentation
  • If possible, foster ideas to improve performance (faster implementation or other solutions)

Source code

  • RailEnv documentation says

The actions of the agents are executed in order of their handle to prevent deadlocks and to allow them to learn relative priorities.
This is not true any more, see https://github.com/flatland-association/flatland-rl/blob/main/notebooks/Agent-Close-Following.ipynb

Book / notebooks/unit tests

  • behaviour should be documented in the core documentation (or at least be consistent with the current implementation)
  • behaviour should be better documented by unit tests
@chenkins chenkins added the documentation Improvements or additions to documentation label Nov 20, 2024
@chenkins chenkins self-assigned this Nov 20, 2024
@chenkins chenkins linked a pull request Nov 20, 2024 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant