[cirqflow] Quantum runtime skeleton - part 1 (#4565)

Skeleton of the constituent parts of `ExecutableGroupResult`

![RequestResponse2 (2)](https://user-images.githubusercontent.com/4967059/136300308-21dd2034-01f7-49a3-84a7-0b0d32928918.png)

Most of these dataclasses only have barebones attributes which may beg the question: "why do we need a class for this?". Rest assured: I have big plans for adding more attributes to things.

This is the first part; splitting up #4556

Author: mpharrigan

cirq-google/cirq_google/__init__.py

@@ -124,6 +124,9 @@
     QuantumExecutable,
     QuantumExecutableGroup,
     BitstringsMeasurement,
+    SharedRuntimeInfo,
+    RuntimeInfo,
+    ExecutableResult,
 )
 
 from cirq_google import experimental

cirq-google/cirq_google/json_resolver_cache.py

@@ -45,4 +45,7 @@ def _class_resolver_dictionary() -> Dict[str, ObjectFactory]:
         'cirq.google.QuantumExecutable': cirq_google.QuantumExecutable,
         'cirq.google.QuantumExecutableGroup': cirq_google.QuantumExecutableGroup,
         'cirq.google.KeyValueExecutableSpec': cirq_google.KeyValueExecutableSpec,
+        'cirq.google.SharedRuntimeInfo': cirq_google.SharedRuntimeInfo,
+        'cirq.google.RuntimeInfo': cirq_google.RuntimeInfo,
+        'cirq.google.ExecutableResult': cirq_google.ExecutableResult,
     }

cirq-google/cirq_google/json_test_data/cirq.google.ExecutableResult.json

@@ -0,0 +1,35 @@
+{
+  "cirq_type": "cirq.google.ExecutableResult",
+  "spec": {
+    "cirq_type": "cirq.google.KeyValueExecutableSpec",
+    "executable_family": "cirq_google.algo_benchmarks.example",
+    "key_value_pairs": [
+      [
+        "name",
+        "test-spec"
+      ]
+    ]
+  },
+  "runtime_info": {
+    "cirq_type": "cirq.google.RuntimeInfo",
+    "execution_index": 5
+  },
+  "raw_data": {
+    "cirq_type": "Result",
+    "params": {
+      "cirq_type": "ParamResolver",
+      "param_dict": []
+    },
+    "measurements": {
+      "z": {
+        "packed_digits": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
+        "binary": true,
+        "dtype": "float64",
+        "shape": [
+          1000,
+          4
+        ]
+      }
+    }
+  }
+}

cirq-google/cirq_google/json_test_data/cirq.google.ExecutableResult.repr

@@ -0,0 +1,4 @@
+{
+  "cirq_type": "cirq.google.RuntimeInfo",
+  "execution_index": 5
+}

cirq-google/cirq_google/json_test_data/cirq.google.RuntimeInfo.json

@@ -0,0 +1 @@
+cirq_google.RuntimeInfo(execution_index=5)

cirq-google/cirq_google/json_test_data/cirq.google.RuntimeInfo.repr

@@ -0,0 +1,4 @@
+{
+  "cirq_type": "cirq.google.SharedRuntimeInfo",
+  "run_id": "my run"
+}

cirq-google/cirq_google/json_test_data/cirq.google.SharedRuntimeInfo.json

@@ -0,0 +1 @@
+cirq_google.SharedRuntimeInfo(run_id='my run')

cirq-google/cirq_google/json_test_data/cirq.google.SharedRuntimeInfo.repr

@@ -59,6 +59,9 @@
             'QuantumExecutable',
             'QuantumExecutableGroup',
             'KeyValueExecutableSpec',
+            'ExecutableResult',
+            'RuntimeInfo',
+            'SharedRuntimeInfo',
         ]
     },
     resolver_cache=_class_resolver_dictionary(),

cirq-google/cirq_google/json_test_data/spec.py

@@ -5,3 +5,9 @@
     QuantumExecutableGroup,
     BitstringsMeasurement,
 )
+
+from cirq_google.workflow.quantum_runtime import (
+    SharedRuntimeInfo,
+    RuntimeInfo,
+    ExecutableResult,
+)

cirq-google/cirq_google/workflow/__init__.py

@@ -0,0 +1,87 @@
+# Copyright 2021 The Cirq Developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Runtime information dataclasses that accompany execution of executables."""
+
+import dataclasses
+from typing import Any, Dict, Optional
+
+import cirq
+from cirq import _compat
+from cirq.protocols import dataclass_json_dict
+from cirq_google.workflow.quantum_executable import (
+    ExecutableSpec,
+)
+
+
+@dataclasses.dataclass
+class SharedRuntimeInfo:
+    """Runtime information common to all `cg.QuantumExecutable`s in an execution of a
+    `cg.QuantumExecutableGroup`.
+
+    There is one `cg.SharedRuntimeInfo` per `cg.ExecutableGroupResult`.
+
+    Args:
+        run_id: A unique `str` identifier for this run.
+    """
+
+    run_id: str
+
+    def _json_dict_(self) -> Dict[str, Any]:
+        return dataclass_json_dict(self, namespace='cirq.google')
+
+    def __repr__(self) -> str:
+        return _compat.dataclass_repr(self, namespace='cirq_google')
+
+
+@dataclasses.dataclass
+class RuntimeInfo:
+    """Runtime information relevant to a particular `cg.QuantumExecutable`.
+
+    There is one `cg.RuntimeInfo` per `cg.ExecutableResult`
+
+    Args:
+        execution_index: What order (in its `cg.QuantumExecutableGroup`) this
+            `cg.QuantumExecutable` was executed.
+    """
+
+    execution_index: int
+
+    def _json_dict_(self) -> Dict[str, Any]:
+        return dataclass_json_dict(self, namespace='cirq.google')
+
+    def __repr__(self) -> str:
+        return _compat.dataclass_repr(self, namespace='cirq_google')
+
+
+@dataclasses.dataclass
+class ExecutableResult:
+    """Results for a `cg.QuantumExecutable`.
+
+    Args:
+        spec: The `cg.ExecutableSpec` typifying the `cg.QuantumExecutable`.
+        runtime_info: A `cg.RuntimeInfo` dataclass containing information gathered during
+            execution of the `cg.QuantumExecutable`.
+        raw_data: The `cirq.Result` containing the data from the run.
+    """
+
+    spec: Optional[ExecutableSpec]
+    runtime_info: RuntimeInfo
+    raw_data: cirq.Result
+
+    def _json_dict_(self) -> Dict[str, Any]:
+        return dataclass_json_dict(self, namespace='cirq.google')
+
+    def __repr__(self) -> str:
+        return _compat.dataclass_repr(self, namespace='cirq_google')

cirq-google/cirq_google/workflow/quantum_runtime.py

@@ -0,0 +1,48 @@
+# Copyright 2021 The Cirq Developers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import cirq
+import cirq_google as cg
+import numpy as np
+from cirq_google.workflow.quantum_executable_test import _get_example_spec
+
+
+def cg_assert_equivalent_repr(value):
+    """cirq.testing.assert_equivalent_repr with cirq_google.workflow imported."""
+    return cirq.testing.assert_equivalent_repr(
+        value,
+        global_vals={
+            'cirq_google': cg,
+        },
+    )
+
+
+def test_shared_runtime_info():
+    shared_rtinfo = cg.SharedRuntimeInfo(run_id='my run')
+    cg_assert_equivalent_repr(shared_rtinfo)
+
+
+def test_runtime_info():
+    rtinfo = cg.RuntimeInfo(execution_index=5)
+    cg_assert_equivalent_repr(rtinfo)
+
+
+def test_executable_result():
+    rtinfo = cg.RuntimeInfo(execution_index=5)
+    er = cg.ExecutableResult(
+        spec=_get_example_spec(name='test-spec'),
+        runtime_info=rtinfo,
+        raw_data=cirq.Result(params=cirq.ParamResolver(), measurements={'z': np.ones((1_000, 4))}),
+    )
+    cg_assert_equivalent_repr(er)