list_experiments()
Lists the names of experiments in a Neptune project.
note
This function only targets experiment head runs.
Parameters
project
str
optional
default: None
Path of the Neptune project, as WorkspaceName/ProjectName
.
If not provided, the NEPTUNE_PROJECT
environment variable is used.
experiments
str | list[str] | Filter
optional
default: None
Filter specifying which experiments to search.
- If a string is provided, it's treated as a regex pattern that the experiment names must match.
- If a list of strings is provided, it's treated as exact experiment names to match.
- To provide a more complex condition on an arbitrary attribute value, pass a
Filter
object.
Examples
List all experiments whose names begin with "sigurd":
import neptune_query as nq
nq.list_experiments(experiments=r"^sigurd")
Search a specific project for experiments with a learning rate less than 0.01:
from neptune_query.filters import Filter
nq.list_experiments(
project="team-alpha/sandbox",
experiments=Filter.lt("config/lr", 0.01),
)