Skip to content

Commit c7f729a

Browse files
authored
add notes
1 parent f933b69 commit c7f729a

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

tensorflow_quantum/release.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,22 @@
66
- TensorFlow Quantum is now compiled with `-std=c++17`, see [install.md](/docs/install.md) for build instructions.
77

88
# Major Features and Improvements
9-
- Significant performance improvements by introducing cuQuantum support for circuit execution on GPU:
10-
- TensorFlow Quantum Keras layers can now be executed on GPU by setting `use_cuquantum=True` at layer instantiation. Examples:
9+
- Significant performance improvements by introducing cuQuantum support for circuit execution on Nvidia GPUs:
10+
- TensorFlow Quantum Keras layers can now be executed on GPU by setting the optional arguement `use_cuquantum=True` at layer instantiation. Examples:
1111
- `tfq.layers.Expectation(use_cuquantum=True)`
1212
- `tfq.layers.SampledExpectation(use_cuquantum=True)` (note that cuQuantum runtime is unsupported for any noisy circuit operations
1313
- `tfq.layers.State(use_cuquantum=True)`
1414
- `tfq.layers.Sample(use_cuquantum=True)`
15-
- `tfq.layers.SimulateSample(use_cuquantum=True)`
15+
- `tfq.layers.PQC(model_circuit, operators, use_cuquantum=True)`
16+
- `tfq.layers.ControlledPQC(model_circuit, operators, use_cuquantum=True)`
17+
- Important notes:
18+
- CuQuantum execution is currently only supported for source distributions meaning that the user must build TensorFlow Quantum & `tensorFlow-cpu` from source following the instructions in [install.md](/docs/install.md#build-from-source).
19+
- Ensure that the first entry is "N" in the `configure.sh` script at [this step](/docs/install.md#6-build-the-tensorflow-quantum-pip-package) of building. This ensures that you build upon `tensorflow-cpu` as `tensorflow-gpu` is unnecessary for CuQuantum support in TensorFlow Quantum.
20+
- The cuQuantum SDK must be installed locally. See [installation instructions](https://docs.nvidia.com/cuda/cuquantum/custatevec/getting_started.html) for details. As part of the installation process, ensure that the `CUQUANTUM_ROOT` environment variable is set (referred to in the installation instructions). If not set, bazel will attempt to locate the folder containing the cuQuantum installation upon running `configure.sh` at [this step](/docs/install.md#6-build-the-tensorflow-quantum-pip-package).
21+
- Tested on Titan, Ampere and Volta Nvidia GPU architectures. Note that Pascal GPU architectures are not supported, see documentation to [check whether your GPU is compatible with cuQuantum](https://docs.nvidia.com/cuda/cuquantum/getting_started.html#custatevec)
22+
- Quantum concurrency (global context option) should be turned off when `use_cuquantum=True`. This can be done by running: `tfq.python.quantum_context.set_quantum_concurrent_op_mode(False)`
23+
24+
1625

1726
# Thanks to our Contributors
1827
This release contains contributions from many people at Google, Nvidia, as well as:

0 commit comments

Comments
 (0)