neptune_fetch_runs_table: Retrieve runs matching the specified criteria.

In neptune-ai/neptune-r: MLOps Metadata Store - Experiment Tracking and Model Registry for Production Teams

Retrieve runs matching the specified criteria.

Description

Retrieve runs matching the specified criteria. All parameters are optional, each of them specifies a single criterion. Only runs matching all of the criteria will be returned. Due to technical limitation only first 10,000 runs matching the criteria are fetched.

Usage

neptune_fetch_runs_table(project, id = NULL, state = NULL, owner = NULL, tag = NULL)

Arguments

project	string - project name
id	(string or vector of strings, optional, default is NULL) - A run's id like "SAN-1" or list of ids like c("SAN-1", "SAN-2"). Matching any element of the list is sufficient to pass the criterion.
state	(string or vector of strings, optional, default is NULL) - A run's state like "active" or list of states like c("inactive", "active"). Possible values: "inactive", "active". Matching any element of the list is sufficient to pass the criterion.
owner	(string or vector of strings, optional, default is NULL) - Username of the run's owner (the user who created the tracked run is an owner) like "josh" or a list of owners like c("frederic", "josh"). Matching any element of the list is sufficient to pass the criterion.
tag	(string or vector of strings, optional, default is NULL) - An experiment tag like "lightGBM" or list of tags like c("pytorch", "cycleLR"). Only experiments that have all specified tags will match this criterion.

Value

RunsTable data in the form of DataFrame.

Author(s)

Authors:

• Mateusz Dominiak

• Maintainer: Neptune DevTeam [e-mail]

See Also

Useful links:

• https://neptune.ai/

• Documentation https://docs.neptune.ai/

• Report bugs at https://github.com/neptune-ai/neptune-r/issues

Examples

## Not run: 
# We are using api token for an anonymous user neptuner. For your projects use your private token.
run <- neptune_init(api_token = ANONYMOUS_API_TOKEN,
                    project = "common-r/quickstarts")
df <- neptune_fetch_runs("common-r/quickstarts")

## End(Not run)

neptune-ai/neptune-r documentation built on Aug. 21, 2023, 6:51 p.m.