# {py:mod}`evox.core.module`

```{py:module} evox.core.module
```

```{autodoc2-docstring} evox.core.module
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`ModuleBase <evox.core.module.ModuleBase>`
  - ```{autodoc2-docstring} evox.core.module.ModuleBase
    :summary:
    ```
* - {py:obj}`TransformGetSetItemToIndex <evox.core.module.TransformGetSetItemToIndex>`
  -
````

### Functions

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

* - {py:obj}`Parameter <evox.core.module.Parameter>`
  - ```{autodoc2-docstring} evox.core.module.Parameter
    :summary:
    ```
* - {py:obj}`Mutable <evox.core.module.Mutable>`
  - ```{autodoc2-docstring} evox.core.module.Mutable
    :summary:
    ```
* - {py:obj}`compile <evox.core.module.compile>`
  - ```{autodoc2-docstring} evox.core.module.compile
    :summary:
    ```
* - {py:obj}`vmap <evox.core.module.vmap>`
  - ```{autodoc2-docstring} evox.core.module.vmap
    :summary:
    ```
* - {py:obj}`use_state <evox.core.module.use_state>`
  - ```{autodoc2-docstring} evox.core.module.use_state
    :summary:
    ```
````

### API

````{py:function} Parameter(value: evox.core.module.ParameterT, dtype: typing.Optional[torch.dtype] = None, device: typing.Optional[torch.device] = None, requires_grad: bool = False) -> evox.core.module.ParameterT
:canonical: evox.core.module.Parameter

```{autodoc2-docstring} evox.core.module.Parameter
```
````

````{py:function} Mutable(value: torch.Tensor, dtype: typing.Optional[torch.dtype] = None, device: typing.Optional[torch.device] = None) -> torch.Tensor
:canonical: evox.core.module.Mutable

```{autodoc2-docstring} evox.core.module.Mutable
```
````

`````{py:class} ModuleBase(*args, **kwargs)
:canonical: evox.core.module.ModuleBase

Bases: {py:obj}`torch.nn.Module`

```{autodoc2-docstring} evox.core.module.ModuleBase
```

```{rubric} Initialization
```

```{autodoc2-docstring} evox.core.module.ModuleBase.__init__
```

````{py:method} eval()
:canonical: evox.core.module.ModuleBase.eval

````

`````

`````{py:class} TransformGetSetItemToIndex()
:canonical: evox.core.module.TransformGetSetItemToIndex

Bases: {py:obj}`torch.overrides.TorchFunctionMode`

````{py:method} __torch_function__(func, types, args, kwargs=None)
:canonical: evox.core.module.TransformGetSetItemToIndex.__torch_function__

```{autodoc2-docstring} evox.core.module.TransformGetSetItemToIndex.__torch_function__
```

````

`````

````{py:function} compile(*args, **kwargs) -> typing.Callable
:canonical: evox.core.module.compile

```{autodoc2-docstring} evox.core.module.compile
```
````

````{py:function} vmap(*args, **kwargs) -> typing.Callable
:canonical: evox.core.module.vmap

```{autodoc2-docstring} evox.core.module.vmap
```
````

````{py:function} use_state(stateful_func: typing.Union[typing.Callable, torch.nn.Module], tie_weights: bool = True, strict: bool = False) -> typing.Callable
:canonical: evox.core.module.use_state

```{autodoc2-docstring} evox.core.module.use_state
```
````