Back to Mlflow

Search Experiments

docs/docs/classic-ml/search/search-experiments/index.mdx

3.12.02.0 KB
Original Source

import TOCInline from "@theme/TOCInline"; import { APILink } from "@site/src/components/APILink";

Search Experiments

<APILink fn="mlflow.search_experiments" /> and <APILink fn="mlflow.client.MlflowClient.search_experiments">MlflowClient.search_experiments()</APILink> support the same filter string syntax as <APILink fn="mlflow.search_runs" /> and <APILink fn="mlflow.client.MlflowClient.search_runs">MlflowClient.search_runs</APILink>, but the supported identifiers and comparators are different.

<TOCInline toc={toc} maxHeadingLevel={3} minHeadingLevel={2} />

Syntax

See Search Runs Syntax for more information.

Identifier

The following identifiers are supported:

  • attributes.name: Experiment name
  • attributes.creation_time: Experiment creation time
  • attributes.last_update_time: Experiment last update time

:::note attributes can be omitted. name is equivalent to attributes.name. :::

  • tags.<tag key>: Tag

Comparator

Comparators for string attributes and tags:

  • =: Equal
  • !=: Not equal
  • LIKE: Case-sensitive pattern match
  • ILIKE: Case-insensitive pattern match

Comparators for tags only:

  • IS NULL: Tag does not exist
  • IS NOT NULL: Tag exists

Comparators for numeric attributes:

  • =: Equal
  • !=: Not equal
  • <: Less than
  • <=: Less than or equal to
  • >: Greater than
  • >=: Greater than or equal to

Examples

python
# Matches experiments with name equal to 'x'
"attributes.name = 'x'"  # or "name = 'x'"

# Matches experiments with name starting with 'x'
"attributes.name LIKE 'x%'"

# Matches experiments with 'group' tag value not equal to 'x'
"tags.group != 'x'"

# Matches experiments with 'group' tag value containing 'x' or 'X'
"tags.group ILIKE '%x%'"

# Matches experiments with name starting with 'x' and 'group' tag value equal to 'y'
"attributes.name LIKE 'x%' AND tags.group = 'y'"

# Matches experiments that have a 'group' tag
"tags.group IS NOT NULL"

# Matches experiments that do NOT have a 'deprecated' tag
"tags.deprecated IS NULL"