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

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

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

## Module Contents

### Classes

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

* - {py:obj}`HTRModel <dawsonia.ml.network.model.HTRModel>`
  - ```{autodoc2-docstring} dawsonia.ml.network.model.HTRModel
    :summary:
    ```
* - {py:obj}`CustomSchedule <dawsonia.ml.network.model.CustomSchedule>`
  - ```{autodoc2-docstring} dawsonia.ml.network.model.CustomSchedule
    :summary:
    ```
````

### Functions

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

* - {py:obj}`bluche <dawsonia.ml.network.model.bluche>`
  - ```{autodoc2-docstring} dawsonia.ml.network.model.bluche
    :summary:
    ```
* - {py:obj}`puigcerver <dawsonia.ml.network.model.puigcerver>`
  - ```{autodoc2-docstring} dawsonia.ml.network.model.puigcerver
    :summary:
    ```
* - {py:obj}`flor <dawsonia.ml.network.model.flor>`
  - ```{autodoc2-docstring} dawsonia.ml.network.model.flor
    :summary:
    ```
* - {py:obj}`puigcerver_octconv <dawsonia.ml.network.model.puigcerver_octconv>`
  - ```{autodoc2-docstring} dawsonia.ml.network.model.puigcerver_octconv
    :summary:
    ```
* - {py:obj}`_create_octconv_last_block <dawsonia.ml.network.model._create_octconv_last_block>`
  - ```{autodoc2-docstring} dawsonia.ml.network.model._create_octconv_last_block
    :summary:
    ```
````

### Data

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

* - {py:obj}`logger <dawsonia.ml.network.model.logger>`
  - ```{autodoc2-docstring} dawsonia.ml.network.model.logger
    :summary:
    ```
````

### API

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

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

````

`````{py:class} HTRModel(architecture: str, input_size: tuple[int, int, int], vocab_size: int, greedy: bool = False, beam_width: int = 10, top_paths: int = 1, stop_tolerance: int = 20, reduce_tolerance: int = 15, cooldown: int = 0)
:canonical: dawsonia.ml.network.model.HTRModel

```{autodoc2-docstring} dawsonia.ml.network.model.HTRModel
```

```{rubric} Initialization
```

```{autodoc2-docstring} dawsonia.ml.network.model.HTRModel.__init__
```

````{py:method} summary(output=None, target=None)
:canonical: dawsonia.ml.network.model.HTRModel.summary

```{autodoc2-docstring} dawsonia.ml.network.model.HTRModel.summary
```

````

````{py:method} load_checkpoint(target)
:canonical: dawsonia.ml.network.model.HTRModel.load_checkpoint

```{autodoc2-docstring} dawsonia.ml.network.model.HTRModel.load_checkpoint
```

````

````{py:method} get_callbacks(logdir, checkpoint, monitor='val_loss', verbose=0)
:canonical: dawsonia.ml.network.model.HTRModel.get_callbacks

```{autodoc2-docstring} dawsonia.ml.network.model.HTRModel.get_callbacks
```

````

````{py:method} compile(learning_rate: dawsonia.ml.network.model.CustomSchedule | float | None = None, initial_step: int = 0)
:canonical: dawsonia.ml.network.model.HTRModel.compile

```{autodoc2-docstring} dawsonia.ml.network.model.HTRModel.compile
```

````

````{py:method} fit(x=None, y=None, batch_size=None, epochs=1, verbose=1, callbacks=None, validation_split=0.0, validation_data=None, shuffle=True, class_weight=None, sample_weight=None, initial_epoch=0, steps_per_epoch=None, validation_steps=None, validation_freq=1, max_queue_size=10, workers=1, use_multiprocessing=False, **kwargs)
:canonical: dawsonia.ml.network.model.HTRModel.fit

```{autodoc2-docstring} dawsonia.ml.network.model.HTRModel.fit
```

````

````{py:method} predict(x, batch_size=None, verbose=0, steps=1, callbacks=None, max_queue_size=10, workers=1, use_multiprocessing=False, ctc_decode=True)
:canonical: dawsonia.ml.network.model.HTRModel.predict

```{autodoc2-docstring} dawsonia.ml.network.model.HTRModel.predict
```

````

````{py:method} ctc_loss_lambda_func(y_true, y_pred)
:canonical: dawsonia.ml.network.model.HTRModel.ctc_loss_lambda_func
:staticmethod:

```{autodoc2-docstring} dawsonia.ml.network.model.HTRModel.ctc_loss_lambda_func
```

````

`````

`````{py:class} CustomSchedule(d_model, initial_step=0, warmup_steps=4000)
:canonical: dawsonia.ml.network.model.CustomSchedule

Bases: {py:obj}`tensorflow.keras.optimizers.schedules.LearningRateSchedule`

```{autodoc2-docstring} dawsonia.ml.network.model.CustomSchedule
```

```{rubric} Initialization
```

```{autodoc2-docstring} dawsonia.ml.network.model.CustomSchedule.__init__
```

````{py:method} __call__(step)
:canonical: dawsonia.ml.network.model.CustomSchedule.__call__

```{autodoc2-docstring} dawsonia.ml.network.model.CustomSchedule.__call__
```

````

`````

````{py:function} bluche(input_size, d_model)
:canonical: dawsonia.ml.network.model.bluche

```{autodoc2-docstring} dawsonia.ml.network.model.bluche
```
````

````{py:function} puigcerver(input_size, d_model)
:canonical: dawsonia.ml.network.model.puigcerver

```{autodoc2-docstring} dawsonia.ml.network.model.puigcerver
```
````

````{py:function} flor(input_size, d_model)
:canonical: dawsonia.ml.network.model.flor

```{autodoc2-docstring} dawsonia.ml.network.model.flor
```
````

````{py:function} puigcerver_octconv(input_size, d_model)
:canonical: dawsonia.ml.network.model.puigcerver_octconv

```{autodoc2-docstring} dawsonia.ml.network.model.puigcerver_octconv
```
````

````{py:function} _create_octconv_last_block(inputs, ch, alpha)
:canonical: dawsonia.ml.network.model._create_octconv_last_block

```{autodoc2-docstring} dawsonia.ml.network.model._create_octconv_last_block
```
````