caution

You're viewing docs for the deprecated Fetcher API.

We recommend upgrading to the new Query API.

list_experiments()

Python package: neptune-fetcher

Returns a list of experiment names in a project.

This function only targets the latest runs of experiments in the project.

Related

• list_runs()
• List project contents via API

Parameters

experiments

str | list[str] | Filter

optional

default: None

A filter specifying which experiments to include:

• a regex that the experiment name must match, or
• a list of specific experiment names, or
• a Filter object.

context

Context

optional

default: None

Which project and API token to use for the fetching operation. Useful for switching projects.

Examples

List all experiments in a project:

import neptune_fetcher.alpha as npt


npt.list_experiments()

Search a different project than the current global context and list only experiments whose name match a certain regex pattern:

my_secondary_project = npt.get_context().with_project("team-beta/project-y")

npt.list_experiments(
    experiments=r"^seagull_.*_02$",
    context=my_secondary_project,
)

Output

['seagull-dt35a_02', 'seagull-987kj_02', 'seagull-56hcs11_02']