# {py:mod}`evorl.sample_batch`

```{py:module} evorl.sample_batch
```

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

## Module Contents

### Classes

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

* - {py:obj}`Episode <evorl.sample_batch.Episode>`
  - ```{autodoc2-docstring} evorl.sample_batch.Episode
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`SampleBatch <evorl.sample_batch.SampleBatch>`
  - ```{autodoc2-docstring} evorl.sample_batch.SampleBatch
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

`````{py:class} Episode
:canonical: evorl.sample_batch.Episode

Bases: {py:obj}`evorl.types.PyTreeData`

```{autodoc2-docstring} evorl.sample_batch.Episode
:parser: autodoc2_docstrings_parser
```

````{py:attribute} trajectory
:canonical: evorl.sample_batch.Episode.trajectory
:type: evorl.sample_batch.SampleBatch
:value: >
   None

```{autodoc2-docstring} evorl.sample_batch.Episode.trajectory
:parser: autodoc2_docstrings_parser
```

````

````{py:property} valid_mask
:canonical: evorl.sample_batch.Episode.valid_mask
:type: chex.Array

```{autodoc2-docstring} evorl.sample_batch.Episode.valid_mask
:parser: autodoc2_docstrings_parser
```

````

`````

`````{py:class} SampleBatch
:canonical: evorl.sample_batch.SampleBatch

Bases: {py:obj}`evorl.types.PyTreeData`, {py:obj}`evorl.types.PyTreeArrayMixin`

```{autodoc2-docstring} evorl.sample_batch.SampleBatch
:parser: autodoc2_docstrings_parser
```

````{py:attribute} actions
:canonical: evorl.sample_batch.SampleBatch.actions
:type: chex.ArrayTree | None
:value: >
   None

```{autodoc2-docstring} evorl.sample_batch.SampleBatch.actions
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} dones
:canonical: evorl.sample_batch.SampleBatch.dones
:type: chex.Array | None
:value: >
   None

```{autodoc2-docstring} evorl.sample_batch.SampleBatch.dones
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} extras
:canonical: evorl.sample_batch.SampleBatch.extras
:type: evorl.types.ExtraInfo | None
:value: >
   None

```{autodoc2-docstring} evorl.sample_batch.SampleBatch.extras
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} next_obs
:canonical: evorl.sample_batch.SampleBatch.next_obs
:type: chex.Array | None
:value: >
   None

```{autodoc2-docstring} evorl.sample_batch.SampleBatch.next_obs
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} obs
:canonical: evorl.sample_batch.SampleBatch.obs
:type: chex.ArrayTree | None
:value: >
   None

```{autodoc2-docstring} evorl.sample_batch.SampleBatch.obs
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} rewards
:canonical: evorl.sample_batch.SampleBatch.rewards
:type: evorl.types.Reward | evorl.types.RewardDict | None
:value: >
   None

```{autodoc2-docstring} evorl.sample_batch.SampleBatch.rewards
:parser: autodoc2_docstrings_parser
```

````

`````