# {py:mod}`dawsonia.ml.api`

```{py:module} dawsonia.ml.api
```

```{autodoc2-docstring} dawsonia.ml.api
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`ML <dawsonia.ml.api.ML>`
  - ```{autodoc2-docstring} dawsonia.ml.api.ML
    :summary:
    ```
````

### API

`````{py:class} ML
:canonical: dawsonia.ml.api.ML

```{autodoc2-docstring} dawsonia.ml.api.ML
```

````{py:attribute} model_path
:canonical: dawsonia.ml.api.ML.model_path
:type: pathlib.Path
:value: >
   'Path(...)'

```{autodoc2-docstring} dawsonia.ml.api.ML.model_path
```

````

````{py:attribute} source
:canonical: dawsonia.ml.api.ML.source
:type: str
:value: >
   'washington'

```{autodoc2-docstring} dawsonia.ml.api.ML.source
```

````

````{py:attribute} arch
:canonical: dawsonia.ml.api.ML.arch
:type: str
:value: >
   'flor'

```{autodoc2-docstring} dawsonia.ml.api.ML.arch
```

````

````{py:attribute} source_path
:canonical: dawsonia.ml.api.ML.source_path
:type: pathlib.Path | None
:value: >
   'field(...)'

```{autodoc2-docstring} dawsonia.ml.api.ML.source_path
```

````

````{py:attribute} output_path
:canonical: dawsonia.ml.api.ML.output_path
:type: pathlib.Path
:value: >
   'field(...)'

```{autodoc2-docstring} dawsonia.ml.api.ML.output_path
```

````

````{py:attribute} checkpoint_path
:canonical: dawsonia.ml.api.ML.checkpoint_path
:type: pathlib.Path
:value: >
   'field(...)'

```{autodoc2-docstring} dawsonia.ml.api.ML.checkpoint_path
```

````

````{py:attribute} learning_rate
:canonical: dawsonia.ml.api.ML.learning_rate
:type: float | None
:value: >
   None

```{autodoc2-docstring} dawsonia.ml.api.ML.learning_rate
```

````

````{py:attribute} tokenizer
:canonical: dawsonia.ml.api.ML.tokenizer
:type: dawsonia.ml.ml.Tokenizer
:value: >
   'field(...)'

```{autodoc2-docstring} dawsonia.ml.api.ML.tokenizer
```

````

````{py:attribute} model
:canonical: dawsonia.ml.api.ML.model
:type: dawsonia.ml.ml.HTRModel
:value: >
   'field(...)'

```{autodoc2-docstring} dawsonia.ml.api.ML.model
```

````

````{py:method} __post_init__()
:canonical: dawsonia.ml.api.ML.__post_init__

```{autodoc2-docstring} dawsonia.ml.api.ML.__post_init__
```

````

````{py:method} predict(image: str | pathlib.Path | numpy.typing.NDArray)
:canonical: dawsonia.ml.api.ML.predict

```{autodoc2-docstring} dawsonia.ml.api.ML.predict
```

````

`````