Skip to main content
Ctrl+K

CHAMOIS

  • User Guide
  • Examples
  • Figures
  • CLI Reference
  • API Reference
    • Preprint
  • GitHub
  • PyPI
  • User Guide
  • Examples
  • Figures
  • CLI Reference
  • API Reference
  • Preprint
  • GitHub
  • PyPI

Section Navigation

Inference

  • Predict (chamois predict)
  • Render (chamois render)

Training

  • Annotate (chamois annotate)
  • Train (chamois train)
  • Validate (chamois validate)
  • Cross-validation (chamois cv)
  • Independent cross-validation (chamois cvi)

Compound Search

  • Compare predictions to compound (chamois compare)
  • Catalog Search (chamois search)

Model Interpretation

  • Explain (chamois explain)
  • CLI Reference
  • Catalog Search (chamois search)

Catalog Search (chamois search)#

usage: chamois search [-h] -i INPUT [-m MODEL] -c CATALOG [-o OUTPUT]
                      [-d DISTANCE_MATRIX] [--rank RANK] [--render]

Named Arguments#

-m, --model

The path to an alternative model used for predicting classes.

Input#

Mandatory input files required by the command.

-i, --input

The chemical classes predicted by CHAMOIS for BGCs.

-c, --catalog

The path to the compound class catalog to compare predictions to.

Output#

Parameters for controlling command output.

-o, --output

The path where to write the catalog search results in TSV format.

-d, --distance-matrix

The path where to write the generated pairwise distance matrix.

--rank

The maximum search rank to record in the table output.

Default: 10

--render

Display best match for each query.

Default: False

previous

Compare predictions to compound (chamois compare)

next

Explain (chamois explain)

On this page
  • Named Arguments
  • Input
  • Output
Edit on GitHub

This Page

  • Show Source

© Copyright 2020-2026, Martin Larralde.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.16.1.