# {py:mod}`ovo.core.database.models_clustering`

```{py:module} ovo.core.database.models_clustering
```

```{autodoc2-docstring} ovo.core.database.models_clustering
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`ProteinClusteringWorkflow <ovo.core.database.models_clustering.ProteinClusteringWorkflow>`
  - ```{autodoc2-docstring} ovo.core.database.models_clustering.ProteinClusteringWorkflow
    :summary:
    ```
* - {py:obj}`ProteinClusteringTool <ovo.core.database.models_clustering.ProteinClusteringTool>`
  - ```{autodoc2-docstring} ovo.core.database.models_clustering.ProteinClusteringTool
    :summary:
    ```
* - {py:obj}`FoldseekParams <ovo.core.database.models_clustering.FoldseekParams>`
  - ```{autodoc2-docstring} ovo.core.database.models_clustering.FoldseekParams
    :summary:
    ```
* - {py:obj}`FoldseekClusteringWorkflow <ovo.core.database.models_clustering.FoldseekClusteringWorkflow>`
  -
````

### Data

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

* - {py:obj}`FOLDSEEK_UMAP_PIPELINE <ovo.core.database.models_clustering.FOLDSEEK_UMAP_PIPELINE>`
  - ```{autodoc2-docstring} ovo.core.database.models_clustering.FOLDSEEK_UMAP_PIPELINE
    :summary:
    ```
* - {py:obj}`PROTEIN_CLUSTERING_TOOLS <ovo.core.database.models_clustering.PROTEIN_CLUSTERING_TOOLS>`
  - ```{autodoc2-docstring} ovo.core.database.models_clustering.PROTEIN_CLUSTERING_TOOLS
    :summary:
    ```
* - {py:obj}`PROTEIN_CLUSTERING_TOOLS_BY_KEY <ovo.core.database.models_clustering.PROTEIN_CLUSTERING_TOOLS_BY_KEY>`
  - ```{autodoc2-docstring} ovo.core.database.models_clustering.PROTEIN_CLUSTERING_TOOLS_BY_KEY
    :summary:
    ```
* - {py:obj}`CLUSTERING_WORKFLOWS_BY_TOOL_KEY <ovo.core.database.models_clustering.CLUSTERING_WORKFLOWS_BY_TOOL_KEY>`
  - ```{autodoc2-docstring} ovo.core.database.models_clustering.CLUSTERING_WORKFLOWS_BY_TOOL_KEY
    :summary:
    ```
````

### API

`````{py:class} ProteinClusteringWorkflow
:canonical: ovo.core.database.models_clustering.ProteinClusteringWorkflow

Bases: {py:obj}`ovo.core.database.models.DescriptorWorkflow`

```{autodoc2-docstring} ovo.core.database.models_clustering.ProteinClusteringWorkflow
```

````{py:attribute} n_neighbors
:canonical: ovo.core.database.models_clustering.ProteinClusteringWorkflow.n_neighbors
:type: typing.List[int]
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.database.models_clustering.ProteinClusteringWorkflow.n_neighbors
```

````

````{py:attribute} tool_key
:canonical: ovo.core.database.models_clustering.ProteinClusteringWorkflow.tool_key
:type: str | None
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_clustering.ProteinClusteringWorkflow.tool_key
```

````

````{py:attribute} params
:canonical: ovo.core.database.models_clustering.ProteinClusteringWorkflow.params
:type: ovo.core.database.models.WorkflowParams
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.database.models_clustering.ProteinClusteringWorkflow.params
```

````

````{py:method} get_registered_workflow_names() -> list[str]
:canonical: ovo.core.database.models_clustering.ProteinClusteringWorkflow.get_registered_workflow_names
:classmethod:

```{autodoc2-docstring} ovo.core.database.models_clustering.ProteinClusteringWorkflow.get_registered_workflow_names
```

````

````{py:method} validate()
:canonical: ovo.core.database.models_clustering.ProteinClusteringWorkflow.validate

```{autodoc2-docstring} ovo.core.database.models_clustering.ProteinClusteringWorkflow.validate
```

````

`````

`````{py:class} ProteinClusteringTool
:canonical: ovo.core.database.models_clustering.ProteinClusteringTool

```{autodoc2-docstring} ovo.core.database.models_clustering.ProteinClusteringTool
```

````{py:attribute} name
:canonical: ovo.core.database.models_clustering.ProteinClusteringTool.name
:type: str
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_clustering.ProteinClusteringTool.name
```

````

````{py:attribute} tool_key
:canonical: ovo.core.database.models_clustering.ProteinClusteringTool.tool_key
:type: str
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_clustering.ProteinClusteringTool.tool_key
```

````

````{py:attribute} supports_conda
:canonical: ovo.core.database.models_clustering.ProteinClusteringTool.supports_conda
:type: bool
:value: >
   False

```{autodoc2-docstring} ovo.core.database.models_clustering.ProteinClusteringTool.supports_conda
```

````

`````

````{py:data} FOLDSEEK_UMAP_PIPELINE
:canonical: ovo.core.database.models_clustering.FOLDSEEK_UMAP_PIPELINE
:value: >
   'ProteinClusteringTool(...)'

```{autodoc2-docstring} ovo.core.database.models_clustering.FOLDSEEK_UMAP_PIPELINE
```

````

`````{py:class} FoldseekParams
:canonical: ovo.core.database.models_clustering.FoldseekParams

Bases: {py:obj}`ovo.core.database.models.WorkflowParams`

```{autodoc2-docstring} ovo.core.database.models_clustering.FoldseekParams
```

````{py:attribute} e
:canonical: ovo.core.database.models_clustering.FoldseekParams.e
:type: float
:value: >
   10.0

```{autodoc2-docstring} ovo.core.database.models_clustering.FoldseekParams.e
```

````

````{py:attribute} alignment_type
:canonical: ovo.core.database.models_clustering.FoldseekParams.alignment_type
:type: int
:value: >
   2

```{autodoc2-docstring} ovo.core.database.models_clustering.FoldseekParams.alignment_type
```

````

````{py:attribute} c
:canonical: ovo.core.database.models_clustering.FoldseekParams.c
:type: float
:value: >
   0.0

```{autodoc2-docstring} ovo.core.database.models_clustering.FoldseekParams.c
```

````

````{py:attribute} tmscore_threshold
:canonical: ovo.core.database.models_clustering.FoldseekParams.tmscore_threshold
:type: float
:value: >
   0.0

```{autodoc2-docstring} ovo.core.database.models_clustering.FoldseekParams.tmscore_threshold
```

````

````{py:attribute} exhaustive_search
:canonical: ovo.core.database.models_clustering.FoldseekParams.exhaustive_search
:type: bool
:value: >
   False

```{autodoc2-docstring} ovo.core.database.models_clustering.FoldseekParams.exhaustive_search
```

````

````{py:attribute} embedding_metric
:canonical: ovo.core.database.models_clustering.FoldseekParams.embedding_metric
:type: str
:value: >
   'qtmscore'

```{autodoc2-docstring} ovo.core.database.models_clustering.FoldseekParams.embedding_metric
```

````

````{py:attribute} min_seq_id
:canonical: ovo.core.database.models_clustering.FoldseekParams.min_seq_id
:type: float
:value: >
   0.0

```{autodoc2-docstring} ovo.core.database.models_clustering.FoldseekParams.min_seq_id
```

````

````{py:attribute} s
:canonical: ovo.core.database.models_clustering.FoldseekParams.s
:type: float
:value: >
   9.5

```{autodoc2-docstring} ovo.core.database.models_clustering.FoldseekParams.s
```

````

`````

`````{py:class} FoldseekClusteringWorkflow
:canonical: ovo.core.database.models_clustering.FoldseekClusteringWorkflow

Bases: {py:obj}`ovo.core.database.models_clustering.ProteinClusteringWorkflow`

````{py:attribute} tool_key
:canonical: ovo.core.database.models_clustering.FoldseekClusteringWorkflow.tool_key
:type: str
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_clustering.FoldseekClusteringWorkflow.tool_key
```

````

````{py:attribute} designs_target
:canonical: ovo.core.database.models_clustering.FoldseekClusteringWorkflow.designs_target
:type: typing.List[ovo.core.database.models.Design]
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.database.models_clustering.FoldseekClusteringWorkflow.designs_target
```

````

````{py:attribute} params
:canonical: ovo.core.database.models_clustering.FoldseekClusteringWorkflow.params
:type: ovo.core.database.models_clustering.FoldseekParams
:value: >
   'field(...)'

```{autodoc2-docstring} ovo.core.database.models_clustering.FoldseekClusteringWorkflow.params
```

````

````{py:method} get_pipeline_name() -> str
:canonical: ovo.core.database.models_clustering.FoldseekClusteringWorkflow.get_pipeline_name

````

````{py:method} prepare_params(workdir: str) -> dict
:canonical: ovo.core.database.models_clustering.FoldseekClusteringWorkflow.prepare_params

````

````{py:method} process_results(job: ovo.core.database.DescriptorJob, callback: typing.Callable = None)
:canonical: ovo.core.database.models_clustering.FoldseekClusteringWorkflow.process_results

````

````{py:method} validate()
:canonical: ovo.core.database.models_clustering.FoldseekClusteringWorkflow.validate

```{autodoc2-docstring} ovo.core.database.models_clustering.FoldseekClusteringWorkflow.validate
```

````

`````

````{py:data} PROTEIN_CLUSTERING_TOOLS
:canonical: ovo.core.database.models_clustering.PROTEIN_CLUSTERING_TOOLS
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_clustering.PROTEIN_CLUSTERING_TOOLS
```

````

````{py:data} PROTEIN_CLUSTERING_TOOLS_BY_KEY
:canonical: ovo.core.database.models_clustering.PROTEIN_CLUSTERING_TOOLS_BY_KEY
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_clustering.PROTEIN_CLUSTERING_TOOLS_BY_KEY
```

````

````{py:data} CLUSTERING_WORKFLOWS_BY_TOOL_KEY
:canonical: ovo.core.database.models_clustering.CLUSTERING_WORKFLOWS_BY_TOOL_KEY
:value: >
   None

```{autodoc2-docstring} ovo.core.database.models_clustering.CLUSTERING_WORKFLOWS_BY_TOOL_KEY
```

````