(events-api)=

# Events

```{eval-rst}
.. automodule:: torch.distributed.elastic.events
```

## API Methods

```{eval-rst}
.. autofunction:: torch.distributed.elastic.events.record
```

```{eval-rst}
.. autofunction:: torch.distributed.elastic.events.construct_and_record_rdzv_event
```

```{eval-rst}
.. autofunction:: torch.distributed.elastic.events.get_logging_handler
```

```{eval-rst}
.. autofunction:: torch.distributed.elastic.events.record_rdzv_event
```

## Event Objects

```{eval-rst}
.. currentmodule:: torch.distributed.elastic.events.api
```

```{eval-rst}
.. autoclass:: torch.distributed.elastic.events.api.Event
```

```{eval-rst}
.. autoclass:: torch.distributed.elastic.events.api.EventSource
```

```{eval-rst}
.. autoclass:: torch.distributed.elastic.events.api.EventMetadataValue
```

```{eval-rst}
.. autoclass:: torch.distributed.elastic.events.api.NodeState
```