Skip to content

Mighty replay buffer

mighty.mighty_replay.mighty_replay_buffer #

Mighty replay buffer.

MightyReplay #

MightyReplay(
    capacity,
    keep_infos=False,
    flatten_infos=False,
    device: device | str = "cpu",
)

Bases: MightyBuffer

Simple replay buffer.

:param capacity: Buffer size :param random_seed: Seed for sampling :param keep_infos: Keep the extra info dict. Required for some algorithms. :param flatten_infos: Make flat list from infos. Might be necessary, depending on info content. :return:

Source code in mighty/mighty_replay/mighty_replay_buffer.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def __init__(
    self,
    capacity,
    keep_infos=False,
    flatten_infos=False,
    device: torch.device | str = "cpu",
):
    """Initialize Buffer.

    :param capacity: Buffer size
    :param random_seed: Seed for sampling
    :param keep_infos: Keep the extra info dict. Required for some algorithms.
    :param flatten_infos: Make flat list from infos.
        Might be necessary, depending on info content.
    :return:
    """
    self.capacity = capacity
    self.keep_infos = keep_infos
    self.flatten_infos = flatten_infos
    self.device = torch.device(device)
    self.rng = np.random.default_rng()
    self.reset()

full property #

full

Check if the buffer is full.

add #

add(transition_batch, _)

Add transition(s).

:param transition_batch: Transition(s) to add :param metrics: Current metrics dict :return:

Source code in mighty/mighty_replay/mighty_replay_buffer.py 
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
def add(self, transition_batch, _):
    """Add transition(s).

    :param transition_batch: Transition(s) to add
    :param metrics: Current metrics dict
    :return:
    """
    if not self.keep_infos:
        transition_batch.extra_info = []
    elif self.flatten_infos:
        transition_batch.extra_info = [
            list(flatten_infos(transition_batch.extra_info))
        ]

    self.index += transition_batch.size
    if len(self.obs) == 0:
        self.obs = transition_batch.observations
        self.next_obs = transition_batch.next_obs
        self.actions = transition_batch.actions
        self.rewards = transition_batch.rewards
        self.dones = transition_batch.dones
    else:
        self.obs = torch.cat((self.obs, transition_batch.observations))
        self.next_obs = torch.cat((self.next_obs, transition_batch.next_obs))
        self.actions = torch.cat((self.actions, transition_batch.actions))
        self.rewards = torch.cat((self.rewards, transition_batch.rewards))
        self.dones = torch.cat((self.dones, transition_batch.dones))
    if len(self) > self.capacity:
        self.obs = self.obs[len(self) - self.capacity :]
        self.next_obs = self.next_obs[len(self) - self.capacity :]
        self.actions = self.actions[len(self) - self.capacity :]
        self.rewards = self.rewards[len(self) - self.capacity :]
        self.dones = self.dones[len(self) - self.capacity :]
        self.index = self.capacity

reset #

reset()

Reset the buffer.

Source code in mighty/mighty_replay/mighty_replay_buffer.py 
162
163
164
165
166
167
168
169
def reset(self):
    """Reset the buffer."""
    self.obs = []
    self.next_obs = []
    self.actions = []
    self.rewards = []
    self.dones = []
    self.index = 0

sample #

sample(batch_size=32)

Sample transitions.

Source code in mighty/mighty_replay/mighty_replay_buffer.py 
150
151
152
153
154
155
156
157
158
159
160
def sample(self, batch_size=32):
    """Sample transitions."""
    batch_indices = self.rng.choice(np.arange(len(self)), size=batch_size)
    return TransitionBatch(
        self.obs[batch_indices],
        self.actions[batch_indices],
        self.rewards[batch_indices],
        self.next_obs[batch_indices],
        self.dones[batch_indices],
        device=self.device,
    )

save #

save(filename='buffer.pkl')

Save the buffer to a file.

Source code in mighty/mighty_replay/mighty_replay_buffer.py 
177
178
179
180
def save(self, filename="buffer.pkl"):
    """Save the buffer to a file."""
    with open(filename, "wb") as f:
        pickle.dump(self, f)

seed #

seed(seed: int)

Set random seed.

Source code in mighty/mighty_replay/buffer.py 
27
28
29
def seed(self, seed: int):
    """Set random seed."""
    self.rng = np.random.default_rng(seed)

TransitionBatch #

TransitionBatch(
    observations,
    actions,
    rewards,
    next_observations,
    dones,
    device: device | str = "cpu",
)

Transition batch.

Source code in mighty/mighty_replay/mighty_replay_buffer.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def __init__(
    self,
    observations,
    actions,
    rewards,
    next_observations,
    dones,
    device: torch.device | str = "cpu",
) -> None:
    """Initialize TransitionBatch."""
    if isinstance(rewards, float | int):
        observations = np.array([observations], dtype=np.float32)
        actions = np.array([actions], dtype=np.float32)
        rewards = np.array([rewards], dtype=np.float32)
        next_observations = np.array([next_observations], dtype=np.float32)
        dones = np.array([dones], dtype=np.float32)
    if isinstance(rewards, np.ndarray):
        self.observations = torch.from_numpy(observations.astype(np.float32)).to(
            device
        )
        self.actions = torch.from_numpy(actions.astype(np.float32)).to(device)
        self.rewards = torch.from_numpy(rewards.astype(np.float32)).to(device)
        self.next_obs = torch.from_numpy(next_observations.astype(np.float32)).to(
            device
        )
        self.dones = torch.from_numpy(dones.astype(np.int64)).to(device)
    else:
        self.observations = observations.to(device)
        self.actions = actions.to(device)
        self.rewards = rewards.to(device)
        self.next_obs = next_observations.to(device)
        self.dones = dones.to(device)

size property #

size

Current buffer size.

flatten_infos #

flatten_infos(xs)

Transform info dict to flat list.

:param xs: info dict :return: flattened infos

Source code in mighty/mighty_replay/mighty_replay_buffer.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
def flatten_infos(xs):
    """Transform info dict to flat list.

    :param xs: info dict
    :return: flattened infos
    """
    if isinstance(xs, dict):
        xs = list(xs.values())
    for x in xs:
        if isinstance(x, Iterable) and not isinstance(x, str | bytes):
            yield from flatten_infos(x)
        else:
            yield x