list_runs()

Lists the IDs of runs in a Neptune project.

note

This function targets all runs, not just experiment heads.

Parameters

project

str

optional

default: None

Path of the Neptune project, as WorkspaceName/ProjectName.

If not provided, the NEPTUNE_PROJECT environment variable is used.

runs

str | list[str] | Filter

optional

default: None

Filter specifying which runs to include.

• If a string is provided, it's treated as a regex pattern that the run IDs must match.
• If a list of strings is provided, it's treated as exact run IDs to match.
• To provide a more complex condition on an arbitrary attribute value, pass a Filter object.

If no filter is specified, all runs are returned.

Examples

List all my runs in a specific project:

import neptune_query.runs as nq_runs
from neptune_query.filters import Filter


nq_runs.list_runs(
    project="team-alpha/sandbox",
    runs=Filter.eq("sys/owner", "MyUsername"),
)