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

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

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

## Module Contents

### Functions

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

* - {py:obj}`adjust_to_see <dawsonia.ml.data.preproc.adjust_to_see>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.adjust_to_see
    :summary:
    ```
* - {py:obj}`augmentation <dawsonia.ml.data.preproc.augmentation>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.augmentation
    :summary:
    ```
* - {py:obj}`normalization <dawsonia.ml.data.preproc.normalization>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.normalization
    :summary:
    ```
* - {py:obj}`preprocess <dawsonia.ml.data.preproc.preprocess>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.preprocess
    :summary:
    ```
* - {py:obj}`text_standardize <dawsonia.ml.data.preproc.text_standardize>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.text_standardize
    :summary:
    ```
````

### Data

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

* - {py:obj}`logger <dawsonia.ml.data.preproc.logger>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.logger
    :summary:
    ```
* - {py:obj}`RE_DASH_FILTER <dawsonia.ml.data.preproc.RE_DASH_FILTER>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.RE_DASH_FILTER
    :summary:
    ```
* - {py:obj}`RE_APOSTROPHE_FILTER <dawsonia.ml.data.preproc.RE_APOSTROPHE_FILTER>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.RE_APOSTROPHE_FILTER
    :summary:
    ```
* - {py:obj}`RE_RESERVED_CHAR_FILTER <dawsonia.ml.data.preproc.RE_RESERVED_CHAR_FILTER>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.RE_RESERVED_CHAR_FILTER
    :summary:
    ```
* - {py:obj}`RE_LEFT_PARENTH_FILTER <dawsonia.ml.data.preproc.RE_LEFT_PARENTH_FILTER>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.RE_LEFT_PARENTH_FILTER
    :summary:
    ```
* - {py:obj}`RE_RIGHT_PARENTH_FILTER <dawsonia.ml.data.preproc.RE_RIGHT_PARENTH_FILTER>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.RE_RIGHT_PARENTH_FILTER
    :summary:
    ```
* - {py:obj}`RE_BASIC_CLEANER <dawsonia.ml.data.preproc.RE_BASIC_CLEANER>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.RE_BASIC_CLEANER
    :summary:
    ```
* - {py:obj}`LEFT_PUNCTUATION_FILTER <dawsonia.ml.data.preproc.LEFT_PUNCTUATION_FILTER>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.LEFT_PUNCTUATION_FILTER
    :summary:
    ```
* - {py:obj}`RIGHT_PUNCTUATION_FILTER <dawsonia.ml.data.preproc.RIGHT_PUNCTUATION_FILTER>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.RIGHT_PUNCTUATION_FILTER
    :summary:
    ```
* - {py:obj}`NORMALIZE_WHITESPACE_REGEX <dawsonia.ml.data.preproc.NORMALIZE_WHITESPACE_REGEX>`
  - ```{autodoc2-docstring} dawsonia.ml.data.preproc.NORMALIZE_WHITESPACE_REGEX
    :summary:
    ```
````

### API

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

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

````

````{py:function} adjust_to_see(img)
:canonical: dawsonia.ml.data.preproc.adjust_to_see

```{autodoc2-docstring} dawsonia.ml.data.preproc.adjust_to_see
```
````

````{py:function} augmentation(imgs, rotation_range=0, scale_range=0, height_shift_range=0, width_shift_range=0, dilate_range=1, erode_range=1)
:canonical: dawsonia.ml.data.preproc.augmentation

```{autodoc2-docstring} dawsonia.ml.data.preproc.augmentation
```
````

````{py:function} normalization(imgs: list[numpy.typing.NDArray]) -> numpy.typing.NDArray[numpy.float32]
:canonical: dawsonia.ml.data.preproc.normalization

```{autodoc2-docstring} dawsonia.ml.data.preproc.normalization
```
````

````{py:function} preprocess(img: str | pathlib.Path | numpy.typing.NDArray | tuple[str, list[int]], input_size: tuple[int, ...])
:canonical: dawsonia.ml.data.preproc.preprocess

```{autodoc2-docstring} dawsonia.ml.data.preproc.preprocess
```
````

````{py:data} RE_DASH_FILTER
:canonical: dawsonia.ml.data.preproc.RE_DASH_FILTER
:value: >
   'compile(...)'

```{autodoc2-docstring} dawsonia.ml.data.preproc.RE_DASH_FILTER
```

````

````{py:data} RE_APOSTROPHE_FILTER
:canonical: dawsonia.ml.data.preproc.RE_APOSTROPHE_FILTER
:value: >
   'compile(...)'

```{autodoc2-docstring} dawsonia.ml.data.preproc.RE_APOSTROPHE_FILTER
```

````

````{py:data} RE_RESERVED_CHAR_FILTER
:canonical: dawsonia.ml.data.preproc.RE_RESERVED_CHAR_FILTER
:value: >
   'compile(...)'

```{autodoc2-docstring} dawsonia.ml.data.preproc.RE_RESERVED_CHAR_FILTER
```

````

````{py:data} RE_LEFT_PARENTH_FILTER
:canonical: dawsonia.ml.data.preproc.RE_LEFT_PARENTH_FILTER
:value: >
   'compile(...)'

```{autodoc2-docstring} dawsonia.ml.data.preproc.RE_LEFT_PARENTH_FILTER
```

````

````{py:data} RE_RIGHT_PARENTH_FILTER
:canonical: dawsonia.ml.data.preproc.RE_RIGHT_PARENTH_FILTER
:value: >
   'compile(...)'

```{autodoc2-docstring} dawsonia.ml.data.preproc.RE_RIGHT_PARENTH_FILTER
```

````

````{py:data} RE_BASIC_CLEANER
:canonical: dawsonia.ml.data.preproc.RE_BASIC_CLEANER
:value: >
   'compile(...)'

```{autodoc2-docstring} dawsonia.ml.data.preproc.RE_BASIC_CLEANER
```

````

````{py:data} LEFT_PUNCTUATION_FILTER
:canonical: dawsonia.ml.data.preproc.LEFT_PUNCTUATION_FILTER
:value: >
   '!%&),.:;<=>?@\\]^_`|}~'

```{autodoc2-docstring} dawsonia.ml.data.preproc.LEFT_PUNCTUATION_FILTER
```

````

````{py:data} RIGHT_PUNCTUATION_FILTER
:canonical: dawsonia.ml.data.preproc.RIGHT_PUNCTUATION_FILTER
:value: >
   '"(/<=>@[\\^_`{|~'

```{autodoc2-docstring} dawsonia.ml.data.preproc.RIGHT_PUNCTUATION_FILTER
```

````

````{py:data} NORMALIZE_WHITESPACE_REGEX
:canonical: dawsonia.ml.data.preproc.NORMALIZE_WHITESPACE_REGEX
:value: >
   'compile(...)'

```{autodoc2-docstring} dawsonia.ml.data.preproc.NORMALIZE_WHITESPACE_REGEX
```

````

````{py:function} text_standardize(text)
:canonical: dawsonia.ml.data.preproc.text_standardize

```{autodoc2-docstring} dawsonia.ml.data.preproc.text_standardize
```
````