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

Update Docs for v0.11 release #1056

Merged
merged 48 commits into from
Mar 26, 2024
Merged

Update Docs for v0.11 release #1056

merged 48 commits into from
Mar 26, 2024

Conversation

jeremiahpslewis
Copy link
Member

PR Checklist

  • Update NEWS.md?
  • Unit tests for all structs / functions?
  • Integration and correctness tests using a simple env?
  • PR Review?
  • Add or update documentation?
  • Write docstrings for new methods?

@jeremiahpslewis
Copy link
Member Author

@HenriDeh after this PR and #1055 have been merged, I'm ready to tag v0.11. Any objections?

@jeremiahpslewis jeremiahpslewis marked this pull request as ready for review March 22, 2024 17:12
Copy link

codecov bot commented Mar 22, 2024

Codecov Report

Attention: Patch coverage is 89.55224% with 14 lines in your changes are missing coverage. Please review.

Project coverage is 62.97%. Comparing base (7b612fb) to head (9f5a6a1).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1056      +/-   ##
==========================================
+ Coverage   62.51%   62.97%   +0.46%     
==========================================
  Files          74       75       +1     
  Lines        2825     2844      +19     
==========================================
+ Hits         1766     1791      +25     
+ Misses       1059     1053       -6     
Files Coverage Δ
src/ReinforcementLearningCore/src/core/hooks.jl 87.09% <100.00%> (ø)
src/ReinforcementLearningCore/src/core/player.jl 100.00% <100.00%> (ø)
...nforcementLearningCore/src/core/stop_conditions.jl 81.81% <100.00%> (+1.17%) ⬆️
...mentLearningCore/src/policies/agent/multi_agent.jl 97.05% <100.00%> (+0.28%) ⬆️
...orcementLearningCore/src/policies/random_policy.jl 27.27% <100.00%> (ø)
...ironments/src/ReinforcementLearningEnvironments.jl 100.00% <ø> (ø)
...ronments/src/environments/examples/KuhnPokerEnv.jl 85.71% <100.00%> (+7.14%) ⬆️
...ngEnvironments/src/environments/examples/PigEnv.jl 91.48% <100.00%> (+0.18%) ⬆️
.../src/environments/examples/RockPaperScissorsEnv.jl 100.00% <100.00%> (ø)
...ronments/src/environments/examples/TicTacToeEnv.jl 90.10% <100.00%> (-1.10%) ⬇️
... and 10 more

... and 1 file with indirect coverage changes

@jeremiahpslewis jeremiahpslewis marked this pull request as draft March 22, 2024 17:46
@jeremiahpslewis jeremiahpslewis marked this pull request as ready for review March 26, 2024 11:08
@jeremiahpslewis
Copy link
Member Author

@HenriDeh Ready to go (I hope)! Had to add three new objects AbstractPlayer, Player, PlayerTuple to deal with type ambiguities between actions / states and players, when actions / states use Symbol type.

@jeremiahpslewis jeremiahpslewis enabled auto-merge (squash) March 26, 2024 11:16
Copy link
Member

@HenriDeh HenriDeh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few remarks otherwise great job !

docs/src/How_to_implement_a_new_algorithm.md Outdated Show resolved Hide resolved
docs/src/How_to_use_hooks.md Outdated Show resolved Hide resolved
docs/src/How_to_write_a_customized_environment.md Outdated Show resolved Hide resolved
docs/src/tips.md Outdated Show resolved Hide resolved
@jeremiahpslewis
Copy link
Member Author

One more thing...ComposedStop was creating all kinds of type stability issues, for little gain; it takes 4-5 lines to define a custom ComposedStop with your favorite reducer. So I dropped it, we now have StopIfAll and StopIfAny; if there's a third really popular one, it can go in the 🐮 🐷 🐔 Farm, but for now we cover 90% of typical usage. ;) @HenriDeh

@jeremiahpslewis
Copy link
Member Author

@HenriDeh Thanks for the thorough review and helpful comments, the PR got a bit out of hand towards the end!

@jeremiahpslewis jeremiahpslewis merged commit de5893f into main Mar 26, 2024
13 checks passed
@jeremiahpslewis jeremiahpslewis deleted the jpsl/docs branch March 26, 2024 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants