.. This Software (Dioptra) is being made available as a public service by the
.. National Institute of Standards and Technology (NIST), an Agency of the United
.. States Department of Commerce. This software was developed in part by employees of
.. NIST and in part by NIST contractors. Copyright in portions of this software that
.. were developed by NIST contractors has been licensed or assigned to NIST. Pursuant
.. to Title 17 United States Code Section 105, works of NIST employees are not
.. subject to copyright protection in the United States. However, NIST may hold
.. international copyright in software created by its employees and domestic
.. copyright (or licensing rights) in portions of software that were assigned or
.. licensed to NIST. To the extent that NIST holds copyright in this software, it is
.. being made available under the Creative Commons Attribution 4.0 International
.. license (CC BY 4.0). The disclaimers of the CC BY 4.0 license apply to all parts
.. of the software developed or licensed by NIST.
..
.. ACCESS THE FULL CC BY 4.0 LICENSE HERE:
.. https://creativecommons.org/licenses/by/4.0/legalcode

.. _reference-snapshots-client-methods:

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.

.. contents:: Contents
   :local:
   :depth: 2


Requirements
------------

- :ref:`explanation-install-dioptra` - an installation and deployment of Dioptra must be available
- :ref:`how-to-set-up-the-python-client` - the Python client must be configured and initialized


.. _reference-snapshots-client-methods-crud-methods:

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**

.. admonition:: Get Snapshots for an Experiment
   :class: code-panel python

   .. code-block:: python

        client.experiments.snapshots.get(experiment_id)


Get Snapshots
~~~~~~~~~~~~~
      
    .. automethod:: dioptra.client.snapshots.SnapshotsSubCollectionClient.get

Get Snapshot by ID
~~~~~~~~~~~~~~~~~~
      
    .. automethod:: dioptra.client.snapshots.SnapshotsSubCollectionClient.get_by_id