ExperimentClient.experiments#

ExperimentClient.experiments(limit, marker, backend_name, experiment_type=None, start_time=None, device_components=None, tags=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None)[source]#

Retrieve experiments, with optional filtering.

Parameters:

  • limit (Optional[int]) – Number of experiments to retrieve.

  • marker (Optional[str]) – Marker used to indicate where to start the next query.

  • backend_name (Optional[str]) – Name of the backend.

  • experiment_type (Optional[str]) – Experiment type.

  • start_time (Optional[List]) – A list of timestamps used to filter by experiment start time.

  • device_components (Optional[List[str]]) – A list of device components used for filtering.

  • tags (Optional[List[str]]) – Tags used for filtering.

  • hub (Optional[str]) – Filter by hub.

  • group (Optional[str]) – Filter by hub and group.

  • project (Optional[str]) – Filter by hub, group, and project.

  • exclude_public (Optional[bool]) – Whether or not to exclude experiments with a public share level.

  • public_only (Optional[bool]) – Whether or not to only return experiments with a public share level.

  • exclude_mine (Optional[bool]) – Whether or not to exclude experiments where I am the owner.

  • mine_only (Optional[bool]) – Whether or not to only return experiments where I am the owner.

  • parent_id (Optional[str]) – Filter by parent experiment ID.

  • sort_by (Optional[str]) – Sorting order.

Return type:

str

Returns:

A list of experiments and the marker, if applicable.