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

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

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

## Module Contents

### Functions

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

* - {py:obj}`model_predict <dawsonia.ml.ml.model_predict>`
  - ```{autodoc2-docstring} dawsonia.ml.ml.model_predict
    :summary:
    ```
* - {py:obj}`make_datagen <dawsonia.ml.ml.make_datagen>`
  - ```{autodoc2-docstring} dawsonia.ml.ml.make_datagen
    :summary:
    ```
* - {py:obj}`make_htr_model <dawsonia.ml.ml.make_htr_model>`
  - ```{autodoc2-docstring} dawsonia.ml.ml.make_htr_model
    :summary:
    ```
* - {py:obj}`model_test <dawsonia.ml.ml.model_test>`
  - ```{autodoc2-docstring} dawsonia.ml.ml.model_test
    :summary:
    ```
* - {py:obj}`model_train <dawsonia.ml.ml.model_train>`
  - ```{autodoc2-docstring} dawsonia.ml.ml.model_train
    :summary:
    ```
````

### Data

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

* - {py:obj}`logger <dawsonia.ml.ml.logger>`
  - ```{autodoc2-docstring} dawsonia.ml.ml.logger
    :summary:
    ```
* - {py:obj}`CHARSET_BASE <dawsonia.ml.ml.CHARSET_BASE>`
  - ```{autodoc2-docstring} dawsonia.ml.ml.CHARSET_BASE
    :summary:
    ```
* - {py:obj}`INPUT_SIZE <dawsonia.ml.ml.INPUT_SIZE>`
  - ```{autodoc2-docstring} dawsonia.ml.ml.INPUT_SIZE
    :summary:
    ```
* - {py:obj}`MAX_TEXT_LENGTH <dawsonia.ml.ml.MAX_TEXT_LENGTH>`
  - ```{autodoc2-docstring} dawsonia.ml.ml.MAX_TEXT_LENGTH
    :summary:
    ```
* - {py:obj}`__all__ <dawsonia.ml.ml.__all__>`
  - ```{autodoc2-docstring} dawsonia.ml.ml.__all__
    :summary:
    ```
````

### API

````{py:data} logger
:canonical: dawsonia.ml.ml.logger
:value: >
   'getLogger(...)'

```{autodoc2-docstring} dawsonia.ml.ml.logger
```

````

````{py:data} CHARSET_BASE
:canonical: dawsonia.ml.ml.CHARSET_BASE
:value: >
   '0123456789n.-+x'

```{autodoc2-docstring} dawsonia.ml.ml.CHARSET_BASE
```

````

````{py:data} INPUT_SIZE
:canonical: dawsonia.ml.ml.INPUT_SIZE
:value: >
   (1024, 128, 1)

```{autodoc2-docstring} dawsonia.ml.ml.INPUT_SIZE
```

````

````{py:data} MAX_TEXT_LENGTH
:canonical: dawsonia.ml.ml.MAX_TEXT_LENGTH
:value: >
   128

```{autodoc2-docstring} dawsonia.ml.ml.MAX_TEXT_LENGTH
```

````

````{py:data} __all__
:canonical: dawsonia.ml.ml.__all__
:value: >
   ('CHARSET_BASE', 'INPUT_SIZE', 'MAX_TEXT_LENGTH', 'make_htr_model', 'model_train', 'model_test', 'mo...

```{autodoc2-docstring} dawsonia.ml.ml.__all__
```

````

````{py:function} model_predict(image: str | pathlib.Path | numpy.typing.NDArray | collections.abc.Iterator[numpy.typing.NDArray], arch: str = '', checkpoint_path: pathlib.Path | None = None, input_size: tuple[int, int, int] = INPUT_SIZE, max_text_length: int = MAX_TEXT_LENGTH, charset_base: str = CHARSET_BASE, tokenizer: dawsonia.ml.data.generator.Tokenizer | None = None, model: dawsonia.ml.network.model.HTRModel | None = None) -> tuple[dawsonia.typing.Prediction, dawsonia.typing.Probability]
:canonical: dawsonia.ml.ml.model_predict

```{autodoc2-docstring} dawsonia.ml.ml.model_predict
```
````

````{py:function} make_datagen(batch_size, source_path, max_text_length: int = MAX_TEXT_LENGTH, charset_base: str = CHARSET_BASE)
:canonical: dawsonia.ml.ml.make_datagen

```{autodoc2-docstring} dawsonia.ml.ml.make_datagen
```
````

````{py:function} make_htr_model(arch, checkpoint_path, vocab_size, input_size=INPUT_SIZE, test_mode=True, learning_rate=None, **kwargs)
:canonical: dawsonia.ml.ml.make_htr_model

```{autodoc2-docstring} dawsonia.ml.ml.make_htr_model
```
````

````{py:function} model_test(norm_accentuation, norm_punctuation, output_path, model, dtgen)
:canonical: dawsonia.ml.ml.model_test

```{autodoc2-docstring} dawsonia.ml.ml.model_test
```
````

````{py:function} model_train(epochs, output_path, checkpoint_path, model: dawsonia.ml.network.model.HTRModel, dtgen: dawsonia.ml.data.generator.DataGenerator)
:canonical: dawsonia.ml.ml.model_train

```{autodoc2-docstring} dawsonia.ml.ml.model_train
```
````