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] Implementation of MultiAgentEpisodeReplayBuffer for the new API stack. #44450

Merged
merged 45 commits into from
Apr 25, 2024
Merged

[RLlib] Implementation of MultiAgentEpisodeReplayBuffer for the new API stack. #44450

merged 45 commits into from
Apr 25, 2024

Conversation

simonsays1980
Copy link
Collaborator

@simonsays1980 simonsays1980 commented Apr 3, 2024 •
edited
Loading

Why are these changes needed?

With the new API stack and the EnvRunner API came the necessity to define new replay buffers that can work completely on episode objects and stores the latter. This PR proposes the multi-agent version of these EpisodeReplayBuffers.

Sampling works in independent and synchronized replay mode and can use different n-step for each item.

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 :(

sven1977 and others added 14 commits March 22, 2024 10:38
@sven1977
wip
b16ab62 
Signed-off-by: sven1977 <[email protected]>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into mult…
72a4bb5 
…i_agent_episode_add_module_for_api
@sven1977
wip
9b60b8c 
Signed-off-by: sven1977 <[email protected]>
@sven1977
wip
297b711 
Signed-off-by: sven1977 <[email protected]>
@sven1977
wip
eb6d04c 
Signed-off-by: sven1977 <[email protected]>
@sven1977
wip
3819712 
Signed-off-by: sven1977 <[email protected]>
@sven1977
merge
2cebf0b 
Signed-off-by: sven1977 <[email protected]>
@sven1977
merge
3a009c8 
Signed-off-by: sven1977 <[email protected]>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into mult…
05d8610 
…i_agent_episode_add_slice_api
@sven1977
wip
11ee869 
Signed-off-by: sven1977 <[email protected]>
@sven1977
wip
559f90d 
Signed-off-by: sven1977 <[email protected]>
@sven1977
wip
8db92d7 
Signed-off-by: sven1977 <[email protected]>
@simonsays1980
Defined 'MultiAgentEpisodeReplayBuffer' class and added '__init__' an…
fc4dc53 
…d 'add' method. Fixed a minor bug in the 'MultiAgentEpisode' b/c the 'agent_module_ids' mapping was not assigned in the 'MultiAgentEpisode.__init__'. Furthermore, added some tests for the new buffer.

Signed-off-by: Simon Zehnder <[email protected]>
@simonsays1980
Defined 'sample' method for 'MultiAgentEpisodeReplayBuffer' to sample…
050b445 
… either 'independent' or

'synchronized'. There appears to be an inconsistency between the action getters of the SingleAgentEpisode' and the 'MultiAgentEpisode' - the latter retrieves the timestep one earlier than observations.

Signed-off-by: Simon Zehnder <[email protected]>
@sven1977 sven1977 changed the title Multi agent episode replay buffer for the new API stack [RLlib] Implementation of MultiAgentEpisodeReplayBuffer for the new API stack. Apr 3, 2024
@sven1977 sven1977 marked this pull request as ready for review April 3, 2024 13:22
sven1977
sven1977 reviewed Apr 3, 2024
View reviewed changes
rllib/utils/replay_buffers/multi_agent_episode_replay_buffer.py Outdated

# Stores indices of module (single-agent) timesteps.
self._module_indices: Dict[str, List[Tuple[int]]] = defaultdict(list)
# Stores for each module the episode indices.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same: improve typehint to DefaultDict[ModuleID, Dict[EpisodeID, int]] ? Is int correct here or should this be a 4-tuple as well?

Let's also above declare what "index" means throughout this entire class:
Something like:
"In this class, we use a global indexing system, where an individual index is a 4-tuple, consisting of 1) ...2)... 3)... 4) ..."

sven1977 and others added 13 commits April 4, 2024 16:11
@sven1977
add proper terminateds/truncateds support to slicing.
e5e2bf3 
Signed-off-by: sven1977 <[email protected]>
@sven1977
LINT
403c541 
Signed-off-by: sven1977 <[email protected]>
@sven1977
doctest fix
d01f6b0 
Signed-off-by: sven1977 <[email protected]>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into mult…
d9eec24 
…i_agent_episode_add_slice_api
@simonsays1980
Merge remote-tracking branch 'sven1977/multi_agent_episode_add_slice_…
c6f0323 
…api' into multi-agent-episode-replay-buffer

Signed-off-by: Simon Zehnder <[email protected]>
@simonsays1980
Added review from @sven1977 and merged changes in 'MultiAgentEpisode'…
d3e2263 
… and 'SingleAgentEpisode'.

Signed-off-by: Simon Zehnder <[email protected]>
@simonsays1980
LINTER.
fdaa40b 
Signed-off-by: Simon Zehnder <[email protected]>
@simonsays1980
Merge branch 'multi-agent-episode-replay-buffer' of github.com:simons…
4f9e991 
…ays1980/ray into multi-agent-episode-replay-buffer

Signed-off-by: Simon Zehnder <[email protected]>
@simonsays1980
Merge branch 'master' into multi-agent-episode-replay-buffer
624ad91 
Signed-off-by: Simon Zehnder <[email protected]>
@simonsays1980
Added getter for metrics and 'get/set_state' for pickling or storing …
1188c36 
…a buffer.

Signed-off-by: Simon Zehnder <[email protected]>
@simonsays1980
Merged master.
68a287c 
Signed-off-by: Simon Zehnder <[email protected]>
@simonsays1980
Refactored getters to override super's getters. In addition added tes…
1d4d535 
…ts for getters and counters.

Signed-off-by: Simon Zehnder <[email protected]>
@simonsays1980
Commented out sampling tests until getters in MultiAgentEpisode are f…
45c5164 
…ixed.

Signed-off-by: Simon Zehnder <[email protected]>
sven1977
sven1977 reviewed Apr 8, 2024
View reviewed changes
rllib/BUILD Outdated
@@ -1524,6 +1524,13 @@ py_test(
srcs = ["utils/replay_buffers/tests/test_episode_replay_buffer.py"]
)

oy_test(
Copy link
Contributor

Choose a reason for hiding this comment

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

-> py_test

sven1977
sven1977 approved these changes Apr 8, 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.

LGTM! Thanks for the fixes.
I understand we'll uncomment those tests for the new buffer once I have fixed the getter API of MultiAgentEpisode.

sven1977
sven1977 reviewed Apr 8, 2024
View reviewed changes
rllib/BUILD Outdated Show resolved Hide resolved
@simonsays1980 simonsays1980 self-assigned this Apr 10, 2024
@sven1977 sven1977 merged commit 97e910b into ray-project:master Apr 25, 2024
5 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

@avnishn avnishn Awaiting requested review from avnishn

@ArturNiederfahrenhorst ArturNiederfahrenhorst Awaiting requested review from ArturNiederfahrenhorst

@maxpumperla maxpumperla Awaiting requested review from maxpumperla

@kouroshHakha kouroshHakha Awaiting requested review from kouroshHakha

Assignees

@simonsays1980 simonsays1980

Labels
rllib-newstack
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@simonsays1980 @sven1977