Project

Project

A class for managing a Neptune project and retrieving information from it.

.fetch_runs_table()

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.

Parameters

id

(str or list of str, optional, default is None) - A run's id like "SAN-1" or list of ids like ["SAN-1", "SAN-2"]. Matching any element of the list is sufficient to pass the criterion.

state

(str or list of str, optional, default is None) - A run's state like "running" or list of states like ["idle", "running"]. Possible values: "idle", "running".

Matching any element of the list is sufficient to pass the criterion.

owner

(str or list of str, optional, default is None) - Username of the run's owner (the user who created the tracked run is an owner) like "josh" or a list of owners like ["frederic", "josh"].

Matching any element of the list is sufficient to pass the criterion.

tag

(str or list of str, optional, default is None) - An experiment tag like "lightGBM" or list of tags like ["pytorch", "cycleLR"]. Only experiments that have all specified tags will match this criterion.

Returns

A RunsTable object containing experiments matching the specified criteria. Use.to_pandas()to convert it to Pandas DataFrame.

RunsTable

An interim object containing fetched runs metadata. To access the data you need to convert it to Pandas DataFrame by invoking .to_pandas().

.to_pandas()

Converts RunsTable data to a Pandas DataFrame object.

Returns

RunsTable data in the form of pandas.DataFrame.