---
orphan: true
---

# {py:mod}`elasticai.preprocessor._check_funcs`

```{py:module} elasticai.preprocessor._check_funcs
```

```{autodoc2-docstring} elasticai.preprocessor._check_funcs
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`MetricTimestamps <elasticai.preprocessor._check_funcs.MetricTimestamps>`
  - ```{autodoc2-docstring} elasticai.preprocessor._check_funcs.MetricTimestamps
    :summary:
    ```
````

### Functions

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

* - {py:obj}`check_key_elements <elasticai.preprocessor._check_funcs.check_key_elements>`
  - ```{autodoc2-docstring} elasticai.preprocessor._check_funcs.check_key_elements
    :summary:
    ```
* - {py:obj}`check_string_equal_elements_all <elasticai.preprocessor._check_funcs.check_string_equal_elements_all>`
  - ```{autodoc2-docstring} elasticai.preprocessor._check_funcs.check_string_equal_elements_all
    :summary:
    ```
* - {py:obj}`check_string_equal_elements_any <elasticai.preprocessor._check_funcs.check_string_equal_elements_any>`
  - ```{autodoc2-docstring} elasticai.preprocessor._check_funcs.check_string_equal_elements_any
    :summary:
    ```
* - {py:obj}`check_keylist_elements_all <elasticai.preprocessor._check_funcs.check_keylist_elements_all>`
  - ```{autodoc2-docstring} elasticai.preprocessor._check_funcs.check_keylist_elements_all
    :summary:
    ```
* - {py:obj}`check_keylist_elements_any <elasticai.preprocessor._check_funcs.check_keylist_elements_any>`
  - ```{autodoc2-docstring} elasticai.preprocessor._check_funcs.check_keylist_elements_any
    :summary:
    ```
* - {py:obj}`check_elem_unique <elasticai.preprocessor._check_funcs.check_elem_unique>`
  - ```{autodoc2-docstring} elasticai.preprocessor._check_funcs.check_elem_unique
    :summary:
    ```
* - {py:obj}`check_value_range <elasticai.preprocessor._check_funcs.check_value_range>`
  - ```{autodoc2-docstring} elasticai.preprocessor._check_funcs.check_value_range
    :summary:
    ```
* - {py:obj}`is_close <elasticai.preprocessor._check_funcs.is_close>`
  - ```{autodoc2-docstring} elasticai.preprocessor._check_funcs.is_close
    :summary:
    ```
* - {py:obj}`compare_timestamps <elasticai.preprocessor._check_funcs.compare_timestamps>`
  - ```{autodoc2-docstring} elasticai.preprocessor._check_funcs.compare_timestamps
    :summary:
    ```
````

### API

````{py:function} check_key_elements(key: str, elements: list[str]) -> bool
:canonical: elasticai.preprocessor._check_funcs.check_key_elements

```{autodoc2-docstring} elasticai.preprocessor._check_funcs.check_key_elements
```
````

````{py:function} check_string_equal_elements_all(text: str, elements: list[str]) -> bool
:canonical: elasticai.preprocessor._check_funcs.check_string_equal_elements_all

```{autodoc2-docstring} elasticai.preprocessor._check_funcs.check_string_equal_elements_all
```
````

````{py:function} check_string_equal_elements_any(text: str, elements: list[str]) -> bool
:canonical: elasticai.preprocessor._check_funcs.check_string_equal_elements_any

```{autodoc2-docstring} elasticai.preprocessor._check_funcs.check_string_equal_elements_any
```
````

````{py:function} check_keylist_elements_all(keylist: list[str], elements: list[str]) -> bool
:canonical: elasticai.preprocessor._check_funcs.check_keylist_elements_all

```{autodoc2-docstring} elasticai.preprocessor._check_funcs.check_keylist_elements_all
```
````

````{py:function} check_keylist_elements_any(keylist: list[str], elements: list[str]) -> bool
:canonical: elasticai.preprocessor._check_funcs.check_keylist_elements_any

```{autodoc2-docstring} elasticai.preprocessor._check_funcs.check_keylist_elements_any
```
````

````{py:function} check_elem_unique(elements: list) -> bool
:canonical: elasticai.preprocessor._check_funcs.check_elem_unique

```{autodoc2-docstring} elasticai.preprocessor._check_funcs.check_elem_unique
```
````

````{py:function} check_value_range(value: float | int, range: list[float | int]) -> bool
:canonical: elasticai.preprocessor._check_funcs.check_value_range

```{autodoc2-docstring} elasticai.preprocessor._check_funcs.check_value_range
```
````

````{py:function} is_close(value: float, target: float, tolerance: float = 0.05) -> bool
:canonical: elasticai.preprocessor._check_funcs.is_close

```{autodoc2-docstring} elasticai.preprocessor._check_funcs.is_close
```
````

`````{py:class} MetricTimestamps
:canonical: elasticai.preprocessor._check_funcs.MetricTimestamps

```{autodoc2-docstring} elasticai.preprocessor._check_funcs.MetricTimestamps
```

````{py:attribute} f1_score
:canonical: elasticai.preprocessor._check_funcs.MetricTimestamps.f1_score
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor._check_funcs.MetricTimestamps.f1_score
```

````

````{py:attribute} TP
:canonical: elasticai.preprocessor._check_funcs.MetricTimestamps.TP
:type: int
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor._check_funcs.MetricTimestamps.TP
```

````

````{py:attribute} FP
:canonical: elasticai.preprocessor._check_funcs.MetricTimestamps.FP
:type: int
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor._check_funcs.MetricTimestamps.FP
```

````

````{py:attribute} FN
:canonical: elasticai.preprocessor._check_funcs.MetricTimestamps.FN
:type: int
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor._check_funcs.MetricTimestamps.FN
```

````

`````

````{py:function} compare_timestamps(true_labels: list, pred_labels: list, window: int = 2) -> elasticai.preprocessor._check_funcs.MetricTimestamps
:canonical: elasticai.preprocessor._check_funcs.compare_timestamps

```{autodoc2-docstring} elasticai.preprocessor._check_funcs.compare_timestamps
```
````