Snapshots Client Methods#

This page lists all relevant methods for Dioptra Snapshots that are available via the Python Client. Snapshots are immutable records of resources (like Experiments or Entrypoints) at a specific point in time.

Requirements#

Snapshots - CRUD methods#

These methods to create, read, update and delete (CRUD) snapshots exist within the class SnapshotsSubCollectionClient.

They are typically accessed via the snapshots property of a parent resource client (e.g., Experiments, Entrypoints).

Example - Get Snapshots for an Experiment

Get Snapshots for an Experiment

client.experiments.snapshots.get(experiment_id)

Get Snapshots#

SnapshotsSubCollectionClient.get(*resource_ids: str | int, index: int = 0, page_length: int = 10, search: str | None = None) → dioptra.client.snapshots.T[source]#

Get the list of snapshots for a given resource.

Parameters

  • *resource_ids – The parent resource ids that own the snapshots sub-collection.

  • index – The paging index. Optional, defaults to 0.

  • page_length – The maximum number of snapshots to return in the paged response. Optional, defaults to 10.

  • search – Search for snapshots using the Dioptra API’s query language. Optional, defaults to None.

Returns

The response from the Dioptra API.

Get Snapshot by ID#

SnapshotsSubCollectionClient.get_by_id(*resource_ids: str | int, snapshot_id: int) → dioptra.client.snapshots.T[source]#

Get a snapshot by its id for a specific resource.

Parameters

  • *resource_ids – The parent resource ids that own the snapshots sub-collection.

  • snapshot_id – The snapshot id, an integer.

Returns

The response from the Dioptra API.