Fix check/nbformat installation and execution (#7004)

* Improve the check/nbformat script

- Fail early if tensorflow-docs installation is broken.
- Use exit status from the nbfmt tool to decide if the format is good.

* Bump up tensorflow-docs to be compatible with protobuf-4

* Format jupyter notebooks

Executed  check/nbformat --apply

Author: pavoljuhas

check/nbformat

@@ -29,28 +29,30 @@ thisdir="$(dirname "${BASH_SOURCE[0]}")" || exit $?
 topdir="$(git -C "${thisdir}" rev-parse --show-toplevel)" || exit $?
 cd "${topdir}" || exit $?
 
-pip show tensorflow-docs > /dev/null || exit 1
+# check if the nbfmt tool in tensorflow-docs is installed and working
+if ! python3 -c "import tensorflow_docs.tools.nbfmt"; then
+    echo -e "\033[31mInstallation of tensorflow-docs is broken, please correct.\033[0m"
+    exit 2
+fi
 
-FORMAT_CMD="python3 -m tensorflow_docs.tools.nbfmt --indent=1"
+my_nbfmt() {
+    python3 -m tensorflow_docs.tools.nbfmt --indent=1 "$@"
+}
 
-# Test the notebooks
-unformatted=$($FORMAT_CMD --test docs 2>&1 | grep "\- docs" || true)
-needed_changes=0
-if [ -n "${unformatted}" ]; then
-    needed_changes=1
-    if (( only_print == 0 )); then
-        $FORMAT_CMD docs
-    else
-        echo -e "\033[31mThe following notebooks require formatting\033[0m."
-        echo "${unformatted}"
-    fi
-fi
+exit_code=0
 
-if (( needed_changes == 0 )); then
+# Check if notebooks are already formatted and store output for later use
+if output=$(my_nbfmt --test docs 2>&1); then
     echo -e "\033[32mNotebooks are formatted\033[0m."
-elif (( only_print == 1 )); then
+elif (( only_print )); then
+    echo -e "\033[31mThe following notebooks require formatting\033[0m."
+    grep "^- docs" <<<"${output}"
     echo -e "\033[33mNotebooks are not formatted. Please run 'check/nbformat --apply'\033[0m"
-    exit 1
+    exit_code=1
 else
-    echo -e "\033[33mReformatted changed notebooks\033[0m."
+    my_nbfmt docs &&
+        echo -e "\033[33mReformatted changed notebooks\033[0m." ||
+        exit_code=$?
 fi
+
+exit ${exit_code}

dev_tools/requirements/deps/tensorflow-docs.txt

@@ -1 +1 @@
-tensorflow-docs@https://github.com/tensorflow/docs/archive/3a6a7a3322de8620f0031ae3a0a4b62e40d1d7f2/master.tar.gz
+tensorflow-docs==2024.2.5.73858

docs/build/interop.ipynb

@@ -254,44 +254,44 @@
   },
   {
    "cell_type": "markdown",
-   "source": [
-     "OpenQASM 3.0 also has limited support, which can be seen by the following code:"
-   ],
    "metadata": {
-     "id": "K_aS_FJxVoHI"
-   }
+    "id": "K_aS_FJxVoHI"
+   },
+   "source": [
+    "OpenQASM 3.0 also has limited support, which can be seen by the following code:"
+   ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "source": [
-     "from cirq.contrib.qasm_import import circuit_from_qasm\n",
-     "circuit = circuit_from_qasm(\"\"\"\n",
-     "OPENQASM 3.0;\n",
-     "include \"stdgates.inc\";\n",
-     "\n",
-     "// Qubits: [q0]\n",
-     "qubit[2] q;\n",
-     "bit[2] m_mmm;\n",
-     "\n",
-     "x q;\n",
-     "m_mmm = measure q;\n",
-     "\"\"\")\n",
-     "print(circuit)"
-   ],
    "metadata": {
-        "id": "LHFjG9trvhla"
+    "id": "LHFjG9trvhla"
    },
    "outputs": [
-     {
-       "output_type": "stream",
-       "name": "stdout",
-       "text": [
-         "q_0: ───X───M('m_mmm_0')───\n",
-         "\n",
-         "q_1: ───X───M('m_mmm_1')───\n"
-       ]
-     }
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "q_0: ───X───M('m_mmm_0')───\n",
+      "\n",
+      "q_1: ───X───M('m_mmm_1')───\n"
+     ]
+    }
+   ],
+   "source": [
+    "from cirq.contrib.qasm_import import circuit_from_qasm\n",
+    "circuit = circuit_from_qasm(\"\"\"\n",
+    "OPENQASM 3.0;\n",
+    "include \"stdgates.inc\";\n",
+    "\n",
+    "// Qubits: [q0]\n",
+    "qubit[2] q;\n",
+    "bit[2] m_mmm;\n",
+    "\n",
+    "x q;\n",
+    "m_mmm = measure q;\n",
+    "\"\"\")\n",
+    "print(circuit)"
    ]
   },
   {
@@ -382,61 +382,61 @@
   },
   {
    "cell_type": "markdown",
-   "source": [
-     "### Exporting cirq.Circuit to QASM format\n",
-     "\n",
-     "Cirq also has the ability to export circuits in OpenQASM format using either OpenQasm 2.0 or 3.0 formats. This can be done using the `circuit.to_qasm()` function, such as\n",
-     "`circuit.to_qasm(version=\"3.0\")` or by using the `cirq.qasm` protocol, as follows:\n"
-   ],
    "metadata": {
-     "id": "fyyz_GGdY5uZ"
-   }
+    "id": "fyyz_GGdY5uZ"
+   },
+   "source": [
+    "### Exporting cirq.Circuit to QASM format\n",
+    "\n",
+    "Cirq also has the ability to export circuits in OpenQASM format using either OpenQasm 2.0 or 3.0 formats. This can be done using the `circuit.to_qasm()` function, such as\n",
+    "`circuit.to_qasm(version=\"3.0\")` or by using the `cirq.qasm` protocol, as follows:\n"
+   ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "source": [
-     "q0 = cirq.NamedQubit('q0')\n",
-     "circuit = cirq.Circuit(cirq.X(q0), cirq.measure(q0, key='mmm'))\n",
-     "qasm_str = cirq.qasm(circuit, args=cirq.QasmArgs(version=\"3.0\"))\n",
-     "print(qasm_str)"
-   ],
    "metadata": {
-        "id": "w62L_PMeVvYl"
+    "id": "w62L_PMeVvYl"
    },
    "outputs": [
-     {
-       "output_type": "stream",
-       "name": "stdout",
-       "text": [
-         "// Generated from Cirq v1.5.0.dev20241221000556\n",
-         "\n",
-         "OPENQASM 3.0;\n",
-         "include \"stdgates.inc\";\n",
-         "\n",
-         "\n",
-         "// Qubits: [q0]\n",
-         "qubit[1] q;\n",
-         "bit[1] m_mmm;\n",
-         "\n",
-         "\n",
-         "x q[0];\n",
-         "m_mmm[0] = measure q[0];\n",
-         "\n"
-       ]
-     }
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "// Generated from Cirq v1.5.0.dev20241221000556\n",
+      "\n",
+      "OPENQASM 3.0;\n",
+      "include \"stdgates.inc\";\n",
+      "\n",
+      "\n",
+      "// Qubits: [q0]\n",
+      "qubit[1] q;\n",
+      "bit[1] m_mmm;\n",
+      "\n",
+      "\n",
+      "x q[0];\n",
+      "m_mmm[0] = measure q[0];\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "q0 = cirq.NamedQubit('q0')\n",
+    "circuit = cirq.Circuit(cirq.X(q0), cirq.measure(q0, key='mmm'))\n",
+    "qasm_str = cirq.qasm(circuit, args=cirq.QasmArgs(version=\"3.0\"))\n",
+    "print(qasm_str)"
    ]
   },
   {
    "cell_type": "markdown",
-   "source": [
-     " Currently supported version strings are \"2.0\" and \"3.0\".\n",
-     "\n",
-     " By default, if no version is specified, circuits are currently exported in OpenQasm 2.0 format.  This default behavior may change in the future so be sure to specify the argument if a specific version of OpenQASM is desired.\n"
-   ],
    "metadata": {
-     "id": "E496hCqZZZUt"
-   }
+    "id": "E496hCqZZZUt"
+   },
+   "source": [
+    " Currently supported version strings are \"2.0\" and \"3.0\".\n",
+    "\n",
+    " By default, if no version is specified, circuits are currently exported in OpenQasm 2.0 format.  This default behavior may change in the future so be sure to specify the argument if a specific version of OpenQASM is desired.\n"
+   ]
   },
   {
    "cell_type": "markdown",

docs/google/internal_gates.ipynb

@@ -83,14 +83,18 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "id": "4783c659ce5d"
+   },
    "source": [
     "Google has a wealth of gates implemented internally that don't exist or have equivalents in Cirq. `cirq_google.InternalGate` allows the creation of Cirq circuits that contain place holder operations that will get translated to the correct internal gate."
    ]
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "id": "9bdd7b2ebcbc"
+   },
    "source": [
     "## InternalGate\n",
     "Instances of [cirq_google.InternalGate](https://github.com/quantumlib/Cirq/blob/61d967112ba23cc839b0e922bd42878024a3e738/cirq-google/cirq_google/ops/internal_gate.py#L20) act as placeholder objects for google internal gates. During translation, the correct gate is identified through the `gate_module` and `gate_name` properties. Then an instance of that gate is created using the `kwargs` arguments passed to the `InternalGate` constructor."
@@ -99,7 +103,9 @@
   {
    "cell_type": "code",
    "execution_count": 6,
-   "metadata": {},
+   "metadata": {
+    "id": "aecb9afa09a0"
+   },
    "outputs": [
     {
      "data": {
@@ -127,7 +133,9 @@
   {
    "cell_type": "code",
    "execution_count": 7,
-   "metadata": {},
+   "metadata": {
+    "id": "f28062274ada"
+   },
    "outputs": [
     {
      "data": {
@@ -153,7 +161,9 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "id": "db0cf657ffea"
+   },
    "source": [
     "## Notes\n",
     "1. InternalGate is serializable.\n",
@@ -164,24 +174,12 @@
  ],
  "metadata": {
   "colab": {
-   "name": "_template.ipynb",
+   "name": "internal_gates.ipynb",
    "toc_visible": true
   },
   "kernelspec": {
    "display_name": "Python 3",
    "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.10.13"
   }
  },
  "nbformat": 4,

docs/hardware/aqt/getting_started.ipynb

@@ -117,15 +117,19 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "id": "29a2d83f816f"
+   },
    "outputs": [],
    "source": [
     "AQTSampler.fetch_resources(access_token)"
    ]
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "id": "322966c20c47"
+   },
    "source": [
     "Then you can specify the workspace and resource you want to send your quantum circuits to."
    ]
@@ -280,15 +284,19 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "id": "5108669495f5"
+   },
    "source": [
     "Then you can use the Sampler Simulator as you would the regular one, for example:"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "id": "4ac3e6439e13"
+   },
    "outputs": [],
    "source": [
     "aqt_sweep = aqt_sampler.run(circuit, repetitions=100)\n",