JuliaReinforcementLearning / GridWorlds.jl

Help! I'm lost in the flatland!
MIT License
46 stars 9 forks source link

update documentation in README #178

Closed Sid-Bhatia-0 closed 3 years ago

Sid-Bhatia-0 commented 3 years ago

Update gifs for all the environments

  1. SingleRoomUndirected single_room_undirected single_room_undirected

  2. SingleRoomDirected single_room_directed single_room_directed

  3. GridRoomsUndirected grid_rooms_undirected grid_rooms_undirected

  4. GridRoomsDirected grid_rooms_directed grid_rooms_directed

  5. SequentialRoomsUndirected sequential_rooms_undirected sequential_rooms_undirected

  6. SequentialRoomsDirected sequential_rooms_directed sequential_rooms_directed

  7. MazeUndirected maze_undirected maze_undirected

  8. MazeDirected maze_directed maze_directed

  9. GoToTargetUndirected go_to_target_undirected go_to_target_undirected

  10. GoToTargetDirected go_to_target_directed go_to_target_directed

  11. DoorKeyUndirected door_key_undirected door_key_undirected

  12. DoorKeyDirected door_key_directed door_key_directed

  13. CollectGemsUndirected collect_gems_undirected collect_gems_undirected

  14. CollectGemsDirected collect_gems_directed collect_gems_directed

  15. CollectGemsMultiAgentUndirected collect_gems_multi_agent_undirected collect_gems_multi_agent_undirected

  16. DynamicObstaclesUndirected dynamic_obstacles_undirected dynamic_obstacles_undirected

  17. DynamicObstaclesDirected dynamic_obstacles_directed dynamic_obstacles_directed

  18. SokobanUndirected sokoban_undirected sokoban_undirected

  19. SokobanDirected sokoban_directed sokoban_directed

  20. Snake snake snake

  21. Catcher catcher catcher

  22. TransportUndirected transport_undirected transport_undirected

  23. TransportDirected transport_directed transport_directed

codecov-commenter commented 3 years ago

Codecov Report

Merging #178 (f960712) into master (e7c748c) will increase coverage by 0.11%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #178      +/-   ##
==========================================
+ Coverage   61.96%   62.08%   +0.11%     
==========================================
  Files          27       27              
  Lines        2624     2624              
==========================================
+ Hits         1626     1629       +3     
+ Misses        998      995       -3     
Impacted Files Coverage Δ
src/envs/catcher.jl 77.77% <0.00%> (+3.33%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update e7c748c...f960712. Read the comment docs.

Sid-Bhatia-0 commented 3 years ago

Updated version of the playing & recording demo: recording_example

Update all gifs in README. Add screenshots and basic descriptions for all environments.