# {py:mod}`evorl.replay_buffers.prioritized_replay_buffer`

```{py:module} evorl.replay_buffers.prioritized_replay_buffer
```

```{autodoc2-docstring} evorl.replay_buffers.prioritized_replay_buffer
:parser: autodoc2_docstrings_parser
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`PrioritizedReplayBuffer <evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer>`
  - ```{autodoc2-docstring} evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`PrioritizedReplayBufferState <evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState>`
  - ```{autodoc2-docstring} evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

`````{py:class} PrioritizedReplayBuffer
:canonical: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer

Bases: {py:obj}`evorl.replay_buffers.replay_buffer.ReplayBuffer`

```{autodoc2-docstring} evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer
:parser: autodoc2_docstrings_parser
```

````{py:method} add(buffer_state: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState, xs: chex.ArrayTree, mask: chex.Array | None = None) -> evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState
:canonical: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer.add

````

````{py:attribute} alpha
:canonical: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer.alpha
:type: float
:value: >
   0.6

```{autodoc2-docstring} evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer.alpha
:parser: autodoc2_docstrings_parser
```

````

````{py:method} init(spec: chex.ArrayTree) -> evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState
:canonical: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer.init

````

````{py:method} reset_max_priority(buffer_state: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState) -> evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState
:canonical: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer.reset_max_priority

```{autodoc2-docstring} evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer.reset_max_priority
:parser: autodoc2_docstrings_parser
```

````

````{py:method} sample(buffer_state: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState, key: chex.PRNGKey, beta: float | chex.Array = 0.4) -> tuple[chex.ArrayTree, chex.Array, evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState]
:canonical: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer.sample

```{autodoc2-docstring} evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer.sample
:parser: autodoc2_docstrings_parser
```

````

````{py:method} update_priority(buffer_state: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState, priority: chex.Array) -> evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState
:canonical: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer.update_priority

```{autodoc2-docstring} evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBuffer.update_priority
:parser: autodoc2_docstrings_parser
```

````

`````

`````{py:class} PrioritizedReplayBufferState
:canonical: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState

Bases: {py:obj}`evorl.replay_buffers.replay_buffer.ReplayBufferState`

```{autodoc2-docstring} evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState
:parser: autodoc2_docstrings_parser
```

````{py:attribute} max_priority
:canonical: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState.max_priority
:type: chex.Array
:value: >
   'ones(...)'

```{autodoc2-docstring} evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState.max_priority
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} priority
:canonical: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState.priority
:type: chex.Array
:value: >
   'zeros(...)'

```{autodoc2-docstring} evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState.priority
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} sample_indices
:canonical: evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState.sample_indices
:type: chex.Array
:value: >
   'zeros(...)'

```{autodoc2-docstring} evorl.replay_buffers.prioritized_replay_buffer.PrioritizedReplayBufferState.sample_indices
:parser: autodoc2_docstrings_parser
```

````

`````