search

JuliaReinforcementLearning / GridWorlds.jl

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

Refactor and clean up #85

Closed Sid-Bhatia-0 closed 3 years ago

Sid-Bhatia-0 commented 3 years ago
  1. Add useful get_... and set_... methods. These methods are extensively reused throughout the code-base.
  2. Use get_char instead of Base.convert to get character representation. Just like get_color is used to get the color of an object, get_char is used to get the character representation of an object. The name get_char better describes this behavior than the name convert.
  3. Use get_world instead of Base.convert (address #81 ) . Reason same as for get_char.
  4. Clean up exports.
  5. Deprecate LRUD in favor of Direction.
  6. Use consistent and informative variable names throughout the code-base.
  7. Remove some unused methods.
codecov-io commented 3 years ago

Codecov Report

Merging #85 (c5f2c48) into master (972eb44) will increase coverage by 0.64%. The diff coverage is 85.17%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #85      +/-   ##
==========================================
+ Coverage   75.19%   75.83%   +0.64%     
==========================================
  Files          15       15              
  Lines         641      658      +17     
==========================================
+ Hits          482      499      +17     
  Misses        159      159
Impacted Files Coverage Δ
src/directions.jl 100.00% <ø> (ø)
src/makie_rendering.jl 0.00% <0.00%> (ø)
src/terminal_rendering.jl 0.00% <0.00%> (ø)
src/objects.jl 21.87% <12.50%> (ø)
src/abstract_grid_world.jl 59.57% <54.54%> (+6.08%) :arrow_up:
src/grid_world_base.jl 71.73% <65.38%> (-2.68%) :arrow_down:
src/envs/sequentialrooms.jl 99.23% <96.29%> (-0.01%) :arrow_down:
src/envs/collectgems.jl 100.00% <100.00%> (ø)
src/envs/doorkey.jl 100.00% <100.00%> (+1.85%) :arrow_up:
src/envs/dynamicobstacles.jl 100.00% <100.00%> (ø)
... and 3 more

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 972eb44...c5f2c48. Read the comment docs.