Farama-Foundation / miniwob-plusplus

MiniWoB++: a web interaction benchmark for reinforcement learning

https://miniwob.farama.org/

MIT License

287 stars 47 forks source link

Updated documentations in docs/ #31

Closed ppasupat closed 1 year ago

ppasupat commented 1 year ago

Description

Updated the documentation in docs/.

The content was mostly lifted from README.
Added example code usage which was lifted from the tests.
Added a video from the defunct site of OpenAI MiniWoB.

Some sections are still missing, mainly the observation and action spaces.

Type of change

Please delete options that are not relevant.

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] This change requires a documentation update

Checklist:

[x] I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes