Indicate that docs/simulate/virtual_engine_interface.ipynb depends on unreleased features

Author: hoisinberg

dev_tools/notebooks/isolated_notebook_test.py

@@ -48,6 +48,9 @@
     'docs/simulate/noisy_simulation.ipynb',
     'docs/simulate/quantum_virtual_machine.ipynb',
     'docs/simulate/qvm_basic_example.ipynb',
+    # Remove once the renaming of `whitelisted_users` -> `allowlisted_users`
+    # throughout cirq_google is released.
+    'docs/simulate/virtual_engine_interface.ipynb',
 ]
 
 # By default all notebooks should be tested, however, this list contains exceptions to the rule
@@ -67,8 +70,6 @@
     # temporary: need to fix QVM metrics and device spec
     'docs/tutorials/google/spin_echoes.ipynb',
     'docs/tutorials/google/visualizing_calibration_metrics.ipynb',
-    # temporary: allow name changes of keyword arguments in quantum engine interfaces to stabilize
-    'docs/simulate/virtual_engine_interface.ipynb',
 ]
 SKIP_NOTEBOOKS += [
     # notebooks that import the examples module which is not installed with cirq

docs/simulate/virtual_engine_interface.ipynb

@@ -31,6 +31,15 @@
     "# limitations under the License."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "id": "ff0101ac0724"
+   },
+   "source": [
+    "Note: this notebook relies on unreleased Cirq features. If you want to try these features, make sure you install cirq-google via `pip install --upgrade cirq-google~=1.0.dev`."
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {
@@ -97,7 +106,7 @@
     "    import cirq_google\n",
     "except ImportError:\n",
     "    print(\"installing cirq...\")\n",
-    "    !pip install --quiet cirq~=1.0.dev cirq-google~=1.0.dev\n",
+    "    !pip install --upgrade --quiet cirq~=1.0.dev cirq-google~=1.0.dev\n",
     "    print(\"installed cirq.\")\n",
     "    import cirq\n",
     "    import cirq_google\n",