PR for saving and loading composite experiments

qiskit_experiments/database_service/database_service.py

@@ -54,6 +54,7 @@ def create_experiment(
         backend_name: str,
         metadata: Optional[Dict] = None,
         experiment_id: Optional[str] = None,
+        parent_id: Optional[str] = None,
         job_ids: Optional[List[str]] = None,
         tags: Optional[List[str]] = None,
         notes: Optional[str] = None,
@@ -68,6 +69,9 @@ def create_experiment(
             metadata: Experiment metadata.
             experiment_id: Experiment ID. It must be in the ``uuid4`` format.
                 One will be generated if not supplied.
+            parent_id: The experiment ID of the parent experiment.
+                The parent experiment must exist, must be on the same backend as the child,
+                and an experiment cannot be its own parent.
             job_ids: IDs of experiment jobs.
             tags: Tags to be associated with the experiment.
             notes: Freeform notes about the experiment.
@@ -78,7 +82,7 @@ def create_experiment(
             Experiment ID.
 
         Raises:
-            ExperimentEntryExists: If the experiment already exits.
+            ExperimentEntryExists: If the experiment already exists.
         """
         pass
 
@@ -134,6 +138,7 @@ def experiments(
         experiment_type: Optional[str] = None,
         backend_name: Optional[str] = None,
         tags: Optional[List[str]] = None,
+        parent_id: Optional[str] = None,
         tags_operator: Optional[str] = "OR",
         **filters: Any,
     ) -> List[Dict]:
@@ -148,6 +153,7 @@ def experiments(
             backend_name: Backend name used for filtering.
             tags: Filter by tags assigned to experiments. This can be used
                 with `tags_operator` for granular filtering.
+            parent_id: Filter by parent experiment ID.
             tags_operator: Logical operator to use when filtering by tags. Valid
                 values are "AND" and "OR":
 

qiskit_experiments/database_service/db_experiment_data.py

@@ -101,6 +101,7 @@ class DbExperimentDataV1(DbExperimentData):
     """
 
     version = 1
+    verbose = True  # Whether to print messages to the standard output.
     _metadata_version = 1
     _executor = futures.ThreadPoolExecutor()
     """Threads used for asynchronous processing."""
@@ -113,6 +114,7 @@ def __init__(
         experiment_type: Optional[str] = "Unknown",
         backend: Optional[Union[Backend, BaseBackend]] = None,
         experiment_id: Optional[str] = None,
+        parent_id: Optional[str] = None,
         tags: Optional[List[str]] = None,
         job_ids: Optional[List[str]] = None,
         share_level: Optional[str] = None,
@@ -127,6 +129,7 @@ def __init__(
             experiment_type: Experiment type.
             backend: Backend the experiment runs on.
             experiment_id: Experiment ID. One will be generated if not supplied.
+            parent_id: The experiment ID of the parent experiment.
             tags: Tags to be associated with the experiment.
             job_ids: IDs of jobs submitted for the experiment.
             share_level: Whether this experiment can be shared with others. This
@@ -154,6 +157,7 @@ def __init__(
         self._set_service_from_backend(backend)
 
         self._id = experiment_id or str(uuid.uuid4())
+        self._parent_id = parent_id
         self._type = experiment_type
         self._tags = tags or []
         self._share_level = share_level
@@ -719,6 +723,18 @@ def analysis_results(
     def save_metadata(self) -> None:
         """Save this experiments metadata to a database service.
 
+        .. note::
+            This method does not save analysis results nor figures.
+            Use :meth:`save` for general saving of all experiment data.
+
+            See :meth:`qiskit.providers.experiment.DatabaseServiceV1.create_experiment`
+            for fields that are saved.
+        """
+        self._save_experiment_metadata()
+
+    def _save_experiment_metadata(self) -> None:
+        """Save this experiments metadata to a database service.
+
         .. note::
             This method does not save analysis results nor figures.
             Use :meth:`save` for general saving of all experiment data.
@@ -758,6 +774,8 @@ def save_metadata(self) -> None:
         new_data = {"experiment_type": self._type, "backend_name": self._backend.name()}
         if self.share_level:
             update_data["share_level"] = self.share_level
+        if self.parent_id:
+            update_data["parent_id"] = self.parent_id
 
         self._created_in_db, _ = save_data(
             is_new=(not self._created_in_db),
@@ -788,7 +806,7 @@ def save(self) -> None:
             )
             return
 
-        self.save_metadata()
+        self._save_experiment_metadata()
         for result in self._analysis_results.values():
             result.save()
 
@@ -817,10 +835,11 @@ def save(self) -> None:
                 self._service.delete_figure(experiment_id=self.experiment_id, figure_name=name)
             self._deleted_figures.remove(name)
 
-        print(
-            "You can view the experiment online at https://quantum-computing.ibm.com/experiments/"
-            + self.experiment_id
-        )
+        if self.verbose:
+            print(
+                "You can view the experiment online at https://quantum-computing.ibm.com/experiments/"
+                + self.experiment_id
+            )
 
     @classmethod
     def load(cls, experiment_id: str, service: DatabaseServiceV1) -> "DbExperimentDataV1":
@@ -843,6 +862,7 @@ def load(cls, experiment_id: str, service: DatabaseServiceV1) -> "DbExperimentDa
             experiment_type=service_data.pop("experiment_type"),
             backend=service_data.pop("backend"),
             experiment_id=service_data.pop("experiment_id"),
+            parent_id=service_data.pop("parent_id"),
             tags=service_data.pop("tags"),
             job_ids=service_data.pop("job_ids"),
             share_level=service_data.pop("share_level"),
@@ -1103,14 +1123,15 @@ def _copy_metadata(
             and metadata but different ID.
         """
         if new_instance is None:
+            # pylint: disable=no-value-for-parameter
             new_instance = self.__class__()
 
         new_instance._type = self.experiment_type
         new_instance._backend = self._backend
         new_instance._tags = self._tags
         new_instance._jobs = self._jobs.copy_object()
         new_instance._share_level = self._share_level
-        new_instance._metadata = self._metadata
+        new_instance._metadata = copy.deepcopy(self._metadata)
         new_instance._notes = self._notes
         new_instance._auto_save = self._auto_save
         new_instance._service = self._service
@@ -1133,6 +1154,7 @@ def _copy_metadata(
                     timeout=orig_kwargs["timeout"],
                     **extra_kwargs,
                 )
+
         return new_instance
 
     @property
@@ -1185,6 +1207,15 @@ def experiment_id(self) -> str:
         """
         return self._id
 
+    @property
+    def parent_id(self) -> str:
+        """Return parent experiment ID
+
+        Returns:
+            Parent ID.
+        """
+        return self._parent_id
+
     @property
     def job_ids(self) -> List[str]:
         """Return experiment job IDs.
@@ -1275,6 +1306,17 @@ def service(self) -> Optional[DatabaseServiceV1]:
     def service(self, service: DatabaseServiceV1) -> None:
         """Set the service to be used for storing experiment data.
 
+        Args:
+            service: Service to be used.
+
+        Raises:
+            DbExperimentDataError: If an experiment service is already being used.
+        """
+        self._set_service(service)
+
+    def _set_service(self, service: DatabaseServiceV1) -> None:
+        """Set the service to be used for storing experiment data.
+
         Args:
             service: Service to be used.
 
@@ -1319,6 +1361,8 @@ def source(self) -> Dict:
     def __repr__(self):
         out = f"{type(self).__name__}({self.experiment_type}"
         out += f", {self.experiment_id}"
+        if self._parent_id:
+            out += f", parent_id={self._parent_id}"
         if self._tags:
             out += f", tags={self._tags}"
         if self.job_ids:

qiskit_experiments/framework/composite/composite_experiment_data.py

@@ -17,40 +17,35 @@
 from qiskit.result import marginal_counts
 from qiskit.exceptions import QiskitError
 from qiskit_experiments.framework.experiment_data import ExperimentData
+from qiskit_experiments.database_service import DbExperimentDataV1, DatabaseServiceV1
 
 
 class CompositeExperimentData(ExperimentData):
     """Composite experiment data class"""
 
-    def __init__(
-        self,
-        experiment,
-        backend=None,
-        job_ids=None,
-    ):
+    def __init__(self, experiment, backend=None, parent_id=None, job_ids=None):
         """Initialize experiment data.
 
         Args:
             experiment (CompositeExperiment): experiment object that generated the data.
             backend (Backend): Optional, Backend the experiment runs on. It can either be a
                 :class:`~qiskit.providers.Backend` instance or just backend name.
+            parent_id (str): Optional, ID of the parent experiment data
+                in the setting of a composite experiment.
             job_ids (list[str]): Optional, IDs of jobs submitted for the experiment.
-
-        Raises:
-            ExperimentError: If an input argument is invalid.
         """
 
-        super().__init__(
-            experiment,
-            backend=backend,
-            job_ids=job_ids,
-        )
+        super().__init__(experiment, backend=backend, parent_id=parent_id, job_ids=job_ids)
 
         # Initialize sub experiments
         self._components = [
-            expr.__experiment_data__(expr, backend) for expr in experiment._experiments
+            expr.__experiment_data__(expr, backend=backend, parent_id=self.experiment_id)
+            for expr in experiment._experiments
         ]
 
+        self.metadata["component_ids"] = [comp.experiment_id for comp in self._components]
+        self.metadata["component_classes"] = [comp.__class__.__name__ for comp in self._components]
+
     def __str__(self):
         line = 51 * "-"
         n_res = len(self._analysis_results)
@@ -103,3 +98,91 @@ def _add_single_data(self, data):
                     else:
                         sub_data["counts"] = data["counts"]
                 self._components[index]._add_single_data(sub_data)
+
+    def save(self) -> None:
+        super().save()
+        for comp in self._components:
+            original_verbose = comp.verbose
+            comp.verbose = False
+            comp.save()
+            comp.verbose = original_verbose
+
+    def save_metadata(self) -> None:
+        super().save_metadata()
+        for comp in self._components:
+            comp.save_metadata()
+
+    @classmethod
+    def load(cls, experiment_id: str, service: DatabaseServiceV1) -> "CompositeExperimentData":
+        expdata = DbExperimentDataV1.load(experiment_id, service)
+        components = []
+        for comp_id, comp_class in zip(
+            expdata.metadata["component_ids"], expdata.metadata["component_classes"]
+        ):
+            load_class = globals()[comp_class]
+            load_func = getattr(load_class, "load")
+            loaded_comp = load_func(comp_id, service)
+            components.append(loaded_comp)
+
+        expdata.__class__ = CompositeExperimentData
+        expdata._experiment = None
+        expdata._components = components
+
+        return expdata
+
+    def _set_service(self, service: DatabaseServiceV1) -> None:
+        """Set the service to be used for storing experiment data.
+
+        Args:
+            service: Service to be used.
+
+        Raises:
+            DbExperimentDataError: If an experiment service is already being used.
+        """
+        super()._set_service(service)
+        for comp in self._components:
+            comp._set_service(service)
+
+    @ExperimentData.share_level.setter
+    def share_level(self, new_level: str) -> None:
+        """Set the experiment share level.
+
+        Args:
+            new_level: New experiment share level. Valid share levels are provider-
+                specified. For example, IBM Quantum experiment service allows
+                "public", "hub", "group", "project", and "private".
+        """
+        self._share_level = new_level
+        for comp in self._components:
+            original_auto_save = comp.auto_save
+            comp.auto_save = False
+            comp.share_level = new_level
+            comp.auto_save = original_auto_save
+        if self.auto_save:
+            self.save_metadata()
+
+    def _copy_metadata(
+        self, new_instance: Optional["CompositeExperimentData"] = None
+    ) -> "CompositeExperimentData":
+        """Make a copy of the composite experiment metadata.
+
+        Note:
+            This method only copies experiment data and metadata, not its
+            figures nor analysis results. The copy also contains a different
+            experiment ID.
+
+        Returns:
+            A copy of the ``CompositeExperimentData`` object with the same data
+            and metadata but different ID.
+        """
+        new_instance = super()._copy_metadata(new_instance)
+
+        for original_comp, new_comp in zip(
+            self.component_experiment_data(), new_instance.component_experiment_data()
+        ):
+            original_comp._copy_metadata(new_comp)
+
+        new_instance.metadata["component_ids"] = [
+            comp.experiment_id for comp in new_instance.component_experiment_data()
+        ]
+        return new_instance

qiskit_experiments/framework/experiment_data.py

@@ -24,26 +24,21 @@
 class ExperimentData(DbExperimentDataV1):
     """Qiskit Experiments Data container class"""
 
-    def __init__(
-        self,
-        experiment=None,
-        backend=None,
-        job_ids=None,
-    ):
+    def __init__(self, experiment=None, backend=None, parent_id=None, job_ids=None):
         """Initialize experiment data.
 
         Args:
             experiment (BaseExperiment): Optional, experiment object that generated the data.
             backend (Backend): Optional, Backend the experiment runs on.
+            parent_id (str): Optional, ID of the parent experiment data
+                in the setting of a composite experiment
             job_ids (list[str]): Optional, IDs of jobs submitted for the experiment.
-
-        Raises:
-            ExperimentError: If an input argument is invalid.
         """
         self._experiment = experiment
         super().__init__(
             experiment_type=experiment.experiment_type if experiment else None,
             backend=backend,
+            parent_id=parent_id,
             job_ids=job_ids,
             metadata=experiment._metadata() if experiment else {},
         )
@@ -80,7 +75,7 @@ def _copy_metadata(self, new_instance: Optional["ExperimentData"] = None) -> "Ex
             and metadata but different ID.
         """
         if new_instance is None:
-            new_instance = ExperimentData(
+            new_instance = self.__class__(
                 experiment=self.experiment, backend=self.backend, job_ids=self.job_ids
             )
         return super()._copy_metadata(new_instance)

releasenotes/notes/save-load-composite-cb882d855dd669be.yaml

@@ -0,0 +1,12 @@
+features:
+  - |
+    Adds support for saving and loading :class:`~qiskit_experiments.framework.ParallelExperiment`
+    and :class:`~qiskit_experiments.framework.BatchExperiment` experiment data,
+    including all their component experiment data and results, to the IBM experiments database service.
+
+    When saving one of these experiments, each component experiment will be saved under a unique experiment ID,
+    which references the original parent composite experiment,
+    via the :meth:`~qiskit_Expeirments.framework.ExperimentData.parent_id`.
+
+    Note that changing the share level of the parent composite experiment will also change the share level of all component experiments.
+