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.

Sign up for GitHub

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

Jump to bottom

[RLlib; Offline RL] Add docstrings to 'MARWIL'. #47157

Merged
merged 26 commits into from
Sep 26, 2024
Merged

[RLlib; Offline RL] Add docstrings to 'MARWIL'. #47157

merged 26 commits into from
Sep 26, 2024
+108 −37

Conversation

simonsays1980
Copy link
Collaborator

@simonsays1980 simonsays1980 commented Aug 15, 2024 •
edited by sven1977
Loading

Why are these changes needed?

This PR completes the in-code documentation for MARWIL, including MARWILOfflinePreLearner. The docstrings incluide testcode to generate instances from each class and use it (if possible).

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@simonsays1980
Added docstring to 'MARWILOfflinePreLearner'.
613acfa 
Signed-off-by: simonsays1980 <simon.zehnder@gmail.com>
@simonsays1980
Merge branch 'master' into add-docstrings-to-marwil
c1563e7
@simonsays1980
Added test code to 'MARWILOfflinePreLearner'.
8b2d98d 
Signed-off-by: simonsays1980 <simon.zehnder@gmail.com>
@simonsays1980
Small nit.
d9b08a5 
Signed-off-by: simonsays1980 <simon.zehnder@gmail.com>
@simonsays1980
Merge branch 'master' into add-docstrings-to-marwil
80271a7
@simonsays1980
Added docstirngs to 'MARWILLearner' and '_training_step_old_api_stack…
c35a0a5 
…'. Furthermore added testcode to 'MARWILConfig' in new style.

Signed-off-by: simonsays1980 <simon.zehnder@gmail.com>
@simonsays1980 simonsays1980 self-assigned this Aug 20, 2024
@sven1977 sven1977 changed the title [RLlib; Offline RL] - Add docstrings to 'MARWIL'. [RLlib; Offline RL] Add docstrings to 'MARWIL'. Aug 20, 2024
@sven1977 sven1977 marked this pull request as ready for review August 20, 2024 18:19
sven1977
sven1977 approved these changes Aug 20, 2024
View reviewed changes
Copy link
Contributor

@sven1977 sven1977 left a comment

Choose a reason for hiding this comment

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

Thanks for the cleanup. Very nice!
LGTM. We should do the other algos, too at some point :)

@sven1977 sven1977 enabled auto-merge (squash) August 20, 2024 18:21
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Aug 20, 2024
@github-actions github-actions bot disabled auto-merge August 23, 2024 07:24
@simonsays1980 simonsays1980 requested a review from a team as a code owner August 30, 2024 16:02
@simonsays1980
Changed data file in 'doc/BUILD' to 'rllib/..'.
f61c0c2 
Signed-off-by: simonsays1980 <simon.zehnder@gmail.com>
@simonsays1980
Merge branch 'master' into add-docstrings-to-marwil
6da5a82
@simonsays1980
Changed path for data in BUILD file for doctests b/c data could still…
2a7e239 
… not be found.

Signed-off-by: simonsays1980 <simon.zehnder@gmail.com>
@simonsays1980 simonsays1980 added rllib RLlib related issues rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples labels Sep 6, 2024
simonsays1980 and others added 2 commits September 11, 2024 12:29
@simonsays1980
Merged master.
4b217f7 
Signed-off-by: simonsays1980 <simon.zehnder@gmail.com>
@can-anyscale
[rllib] add data to doctest
f747100 
Signed-off-by: can <can@anyscale.com>
@sven1977 sven1977 enabled auto-merge (squash) September 26, 2024 17:30
@sven1977 sven1977 merged commit d8d9f6b into ray-project:master Sep 26, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sven1977 sven1977 sven1977 approved these changes

@can-anyscale can-anyscale can-anyscale approved these changes

@ArturNiederfahrenhorst ArturNiederfahrenhorst Awaiting requested review from ArturNiederfahrenhorst ArturNiederfahrenhorst is a code owner

Assignees

@simonsays1980 simonsays1980

Labels
go add ONLY when ready to merge, run all tests rllib RLlib related issues rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@simonsays1980 @sven1977 @can-anyscale