# {py:mod}`ovo.app.components.clustering_components`

```{py:module} ovo.app.components.clustering_components
```

```{autodoc2-docstring} ovo.app.components.clustering_components
:allowtitles:
```

## Module Contents

### Functions

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

* - {py:obj}`set_foldseek_params <ovo.app.components.clustering_components.set_foldseek_params>`
  - ```{autodoc2-docstring} ovo.app.components.clustering_components.set_foldseek_params
    :summary:
    ```
* - {py:obj}`umap_scatterplot_plot_preset <ovo.app.components.clustering_components.umap_scatterplot_plot_preset>`
  - ```{autodoc2-docstring} ovo.app.components.clustering_components.umap_scatterplot_plot_preset
    :summary:
    ```
* - {py:obj}`get_cluster_legend <ovo.app.components.clustering_components.get_cluster_legend>`
  - ```{autodoc2-docstring} ovo.app.components.clustering_components.get_cluster_legend
    :summary:
    ```
* - {py:obj}`umap_scatterplot_component <ovo.app.components.clustering_components.umap_scatterplot_component>`
  - ```{autodoc2-docstring} ovo.app.components.clustering_components.umap_scatterplot_component
    :summary:
    ```
* - {py:obj}`cluster_representatives_tiles <ovo.app.components.clustering_components.cluster_representatives_tiles>`
  - ```{autodoc2-docstring} ovo.app.components.clustering_components.cluster_representatives_tiles
    :summary:
    ```
* - {py:obj}`inspect_clusters <ovo.app.components.clustering_components.inspect_clusters>`
  - ```{autodoc2-docstring} ovo.app.components.clustering_components.inspect_clusters
    :summary:
    ```
* - {py:obj}`display_clustering_job_params <ovo.app.components.clustering_components.display_clustering_job_params>`
  - ```{autodoc2-docstring} ovo.app.components.clustering_components.display_clustering_job_params
    :summary:
    ```
* - {py:obj}`download_descriptors_from_job <ovo.app.components.clustering_components.download_descriptors_from_job>`
  - ```{autodoc2-docstring} ovo.app.components.clustering_components.download_descriptors_from_job
    :summary:
    ```
* - {py:obj}`display_clustering_metrics <ovo.app.components.clustering_components.display_clustering_metrics>`
  - ```{autodoc2-docstring} ovo.app.components.clustering_components.display_clustering_metrics
    :summary:
    ```
````

### Data

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

* - {py:obj}`FOLDSEEK_ALIGNMENT_DESCRIPTIONS_MAP <ovo.app.components.clustering_components.FOLDSEEK_ALIGNMENT_DESCRIPTIONS_MAP>`
  - ```{autodoc2-docstring} ovo.app.components.clustering_components.FOLDSEEK_ALIGNMENT_DESCRIPTIONS_MAP
    :summary:
    ```
````

### API

````{py:data} FOLDSEEK_ALIGNMENT_DESCRIPTIONS_MAP
:canonical: ovo.app.components.clustering_components.FOLDSEEK_ALIGNMENT_DESCRIPTIONS_MAP
:value: >
   None

```{autodoc2-docstring} ovo.app.components.clustering_components.FOLDSEEK_ALIGNMENT_DESCRIPTIONS_MAP
```

````

````{py:function} set_foldseek_params(workflow: ovo.core.database.models_clustering.FoldseekClusteringWorkflow, key_suffix: str = '') -> ovo.core.database.models_clustering.FoldseekClusteringWorkflow
:canonical: ovo.app.components.clustering_components.set_foldseek_params

```{autodoc2-docstring} ovo.app.components.clustering_components.set_foldseek_params
```
````

````{py:function} umap_scatterplot_plot_preset(df_descriptor_values, setting: ovo.app.components.descriptor_scatterplot.PlotSettings, cluster_legend: dict, tool: str, key: str = 'preset_scatterplot')
:canonical: ovo.app.components.clustering_components.umap_scatterplot_plot_preset

```{autodoc2-docstring} ovo.app.components.clustering_components.umap_scatterplot_plot_preset
```
````

````{py:function} get_cluster_legend(df_descriptor_values, tool: str) -> dict
:canonical: ovo.app.components.clustering_components.get_cluster_legend

```{autodoc2-docstring} ovo.app.components.clustering_components.get_cluster_legend
```
````

````{py:function} umap_scatterplot_component(df_descriptor_values, tool: str)
:canonical: ovo.app.components.clustering_components.umap_scatterplot_component

```{autodoc2-docstring} ovo.app.components.clustering_components.umap_scatterplot_component
```
````

````{py:function} cluster_representatives_tiles(df_descriptor_values, tool: str, job: ovo.core.database.DescriptorJob, max_representatives: int = 6)
:canonical: ovo.app.components.clustering_components.cluster_representatives_tiles

```{autodoc2-docstring} ovo.app.components.clustering_components.cluster_representatives_tiles
```
````

````{py:function} inspect_clusters(df_descriptor_values, tool: str, job: ovo.core.database.DescriptorJob)
:canonical: ovo.app.components.clustering_components.inspect_clusters

```{autodoc2-docstring} ovo.app.components.clustering_components.inspect_clusters
```
````

````{py:function} display_clustering_job_params(job: ovo.core.database.DescriptorJob)
:canonical: ovo.app.components.clustering_components.display_clustering_job_params

```{autodoc2-docstring} ovo.app.components.clustering_components.display_clustering_job_params
```
````

````{py:function} download_descriptors_from_job(df_descriptor_values: pandas.DataFrame, job: ovo.core.database.DescriptorJob)
:canonical: ovo.app.components.clustering_components.download_descriptors_from_job

```{autodoc2-docstring} ovo.app.components.clustering_components.download_descriptors_from_job
```
````

````{py:function} display_clustering_metrics(df_descriptor_values: pandas.DataFrame, job: ovo.core.database.DescriptorJob)
:canonical: ovo.app.components.clustering_components.display_clustering_metrics

```{autodoc2-docstring} ovo.app.components.clustering_components.display_clustering_metrics
```
````