# {py:mod}`feedback_forensics.data.handler`

```{py:module} feedback_forensics.data.handler
```

```{autodoc2-docstring} feedback_forensics.data.handler
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`ColumnHandler <feedback_forensics.data.handler.ColumnHandler>`
  - ```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler
    :summary:
    ```
* - {py:obj}`DatasetHandler <feedback_forensics.data.handler.DatasetHandler>`
  - ```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler
    :summary:
    ```
````

### Functions

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

* - {py:obj}`_get_annotator_df_col_names <feedback_forensics.data.handler._get_annotator_df_col_names>`
  - ```{autodoc2-docstring} feedback_forensics.data.handler._get_annotator_df_col_names
    :summary:
    ```
* - {py:obj}`_split_votes_dict <feedback_forensics.data.handler._split_votes_dict>`
  - ```{autodoc2-docstring} feedback_forensics.data.handler._split_votes_dict
    :summary:
    ```
````

### API

````{py:function} _get_annotator_df_col_names(annotator_visible_names: list[str], votes_dicts: dict[str, dict]) -> list[str]
:canonical: feedback_forensics.data.handler._get_annotator_df_col_names

```{autodoc2-docstring} feedback_forensics.data.handler._get_annotator_df_col_names
```
````

````{py:function} _split_votes_dict(votes_dict: dict, split_col: str, selected_vals: list[str] | None = None) -> dict
:canonical: feedback_forensics.data.handler._split_votes_dict

```{autodoc2-docstring} feedback_forensics.data.handler._split_votes_dict
```
````

`````{py:class} ColumnHandler(cache: dict | None = None, avail_datasets: dict | None = None, reference_models: list[str] | None = None)
:canonical: feedback_forensics.data.handler.ColumnHandler

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler
```

```{rubric} Initialization
```

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.__init__
```

````{py:property} votes_dict
:canonical: feedback_forensics.data.handler.ColumnHandler.votes_dict

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.votes_dict
```

````

````{py:property} cache
:canonical: feedback_forensics.data.handler.ColumnHandler.cache

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.cache
```

````

````{py:property} avail_datasets
:canonical: feedback_forensics.data.handler.ColumnHandler.avail_datasets

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.avail_datasets
```

````

````{py:property} df
:canonical: feedback_forensics.data.handler.ColumnHandler.df

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.df
```

````

````{py:property} annotator_metadata
:canonical: feedback_forensics.data.handler.ColumnHandler.annotator_metadata

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.annotator_metadata
```

````

````{py:property} reference_annotator_col
:canonical: feedback_forensics.data.handler.ColumnHandler.reference_annotator_col

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.reference_annotator_col
```

````

````{py:property} shown_annotator_rows
:canonical: feedback_forensics.data.handler.ColumnHandler.shown_annotator_rows

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.shown_annotator_rows
```

````

````{py:property} data_path
:canonical: feedback_forensics.data.handler.ColumnHandler.data_path

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.data_path
```

````

````{py:property} default_annotator_rows
:canonical: feedback_forensics.data.handler.ColumnHandler.default_annotator_rows

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.default_annotator_rows
```

````

````{py:property} default_annotator_cols
:canonical: feedback_forensics.data.handler.ColumnHandler.default_annotator_cols

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.default_annotator_cols
```

````

````{py:method} get_annotator_visible_name(annotator_col: str)
:canonical: feedback_forensics.data.handler.ColumnHandler.get_annotator_visible_name

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.get_annotator_visible_name
```

````

````{py:method} _get_data_path(dataset_name: str)
:canonical: feedback_forensics.data.handler.ColumnHandler._get_data_path

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler._get_data_path
```

````

````{py:method} load_data_from_name(name: str)
:canonical: feedback_forensics.data.handler.ColumnHandler.load_data_from_name

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.load_data_from_name
```

````

````{py:method} load_data_from_path(dataset_path: str | pathlib.Path)
:canonical: feedback_forensics.data.handler.ColumnHandler.load_data_from_path

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.load_data_from_path
```

````

````{py:method} load_from_votes_dict(votes_dict: dict)
:canonical: feedback_forensics.data.handler.ColumnHandler.load_from_votes_dict

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.load_from_votes_dict
```

````

````{py:method} set_visible_annotator_rows(annotator_rows_keys: list[str])
:canonical: feedback_forensics.data.handler.ColumnHandler.set_visible_annotator_rows

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.set_visible_annotator_rows
```

````

````{py:method} compute_overall_metrics()
:canonical: feedback_forensics.data.handler.ColumnHandler.compute_overall_metrics

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.compute_overall_metrics
```

````

````{py:method} compute_annotator_metrics()
:canonical: feedback_forensics.data.handler.ColumnHandler.compute_annotator_metrics

```{autodoc2-docstring} feedback_forensics.data.handler.ColumnHandler.compute_annotator_metrics
```

````

`````

`````{py:class} DatasetHandler(cache: dict | None = None, avail_datasets: dict | None = None, reference_models: list[str] | None = None)
:canonical: feedback_forensics.data.handler.DatasetHandler

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler
```

```{rubric} Initialization
```

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.__init__
```

````{py:property} cache
:canonical: feedback_forensics.data.handler.DatasetHandler.cache

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.cache
```

````

````{py:property} avail_datasets
:canonical: feedback_forensics.data.handler.DatasetHandler.avail_datasets

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.avail_datasets
```

````

````{py:property} col_handlers
:canonical: feedback_forensics.data.handler.DatasetHandler.col_handlers

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.col_handlers
```

````

````{py:property} first_handler
:canonical: feedback_forensics.data.handler.DatasetHandler.first_handler

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.first_handler
```

````

````{py:property} first_handler_name
:canonical: feedback_forensics.data.handler.DatasetHandler.first_handler_name

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.first_handler_name
```

````

````{py:property} is_single_dataset
:canonical: feedback_forensics.data.handler.DatasetHandler.is_single_dataset

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.is_single_dataset
```

````

````{py:property} votes_dicts
:canonical: feedback_forensics.data.handler.DatasetHandler.votes_dicts

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.votes_dicts
```

````

````{py:property} num_cols
:canonical: feedback_forensics.data.handler.DatasetHandler.num_cols

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.num_cols
```

````

````{py:method} add_col_handler(name: str, handler: feedback_forensics.data.handler.ColumnHandler)
:canonical: feedback_forensics.data.handler.DatasetHandler.add_col_handler

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.add_col_handler
```

````

````{py:method} reset_handlers()
:canonical: feedback_forensics.data.handler.DatasetHandler.reset_handlers

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.reset_handlers
```

````

````{py:method} add_data_from_name(name: str)
:canonical: feedback_forensics.data.handler.DatasetHandler.add_data_from_name

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.add_data_from_name
```

````

````{py:method} load_data_from_names(names: list[str])
:canonical: feedback_forensics.data.handler.DatasetHandler.load_data_from_names

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.load_data_from_names
```

````

````{py:method} add_data_from_path(path: str | pathlib.Path, name: str | None = None)
:canonical: feedback_forensics.data.handler.DatasetHandler.add_data_from_path

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.add_data_from_path
```

````

````{py:method} load_data_from_paths(paths: list[str | pathlib.Path])
:canonical: feedback_forensics.data.handler.DatasetHandler.load_data_from_paths

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.load_data_from_paths
```

````

````{py:method} add_data_from_votes_dict(votes_dict: dict, name: str)
:canonical: feedback_forensics.data.handler.DatasetHandler.add_data_from_votes_dict

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.add_data_from_votes_dict
```

````

````{py:method} load_data_from_votes_dicts(votes_dicts: dict[str, dict])
:canonical: feedback_forensics.data.handler.DatasetHandler.load_data_from_votes_dicts

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.load_data_from_votes_dicts
```

````

````{py:method} get_col_handler(name: str)
:canonical: feedback_forensics.data.handler.DatasetHandler.get_col_handler

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.get_col_handler
```

````

````{py:method} get_available_annotators()
:canonical: feedback_forensics.data.handler.DatasetHandler.get_available_annotators

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.get_available_annotators
```

````

````{py:method} get_available_annotator_visible_names()
:canonical: feedback_forensics.data.handler.DatasetHandler.get_available_annotator_visible_names

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.get_available_annotator_visible_names
```

````

````{py:method} set_annotator_rows(annotator_visible_names: list[str] | None = None, annotator_keys: list[str] | None = None)
:canonical: feedback_forensics.data.handler.DatasetHandler.set_annotator_rows

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.set_annotator_rows
```

````

````{py:method} split_by_col(col: str, selected_vals: list[str] | None = None)
:canonical: feedback_forensics.data.handler.DatasetHandler.split_by_col

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.split_by_col
```

````

````{py:method} set_annotator_cols(annotator_visible_names: list[str] | None = None, annotator_keys: list[str] | None = None)
:canonical: feedback_forensics.data.handler.DatasetHandler.set_annotator_cols

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.set_annotator_cols
```

````

````{py:method} get_overall_metrics()
:canonical: feedback_forensics.data.handler.DatasetHandler.get_overall_metrics

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.get_overall_metrics
```

````

````{py:method} get_annotator_metrics()
:canonical: feedback_forensics.data.handler.DatasetHandler.get_annotator_metrics

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.get_annotator_metrics
```

````

````{py:method} get_annotator_metrics_df(metric_name: str, add_max_diff_col: bool = True, index_col_name: str = 'Annotator')
:canonical: feedback_forensics.data.handler.DatasetHandler.get_annotator_metrics_df

```{autodoc2-docstring} feedback_forensics.data.handler.DatasetHandler.get_annotator_metrics_df
```

````

`````
