Docs preview for PR #1728.

NVIDIA · Jun 27, 2024 · 9fde893 · 9fde893
1 parent 1f67bad
commit 9fde893
Show file tree

Hide file tree

Showing 154 changed files with 10,743 additions and 9,714 deletions.
diff --git a/pr-1728/CMakeLists.txt b/pr-1728/CMakeLists.txt
@@ -59,7 +59,6 @@ endif()
 
 # code snippets in docs
 add_nvqpp_test(QuickStart_default quick_start.cpp SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/sphinx/snippets/cpp)
-add_nvqpp_test(FirstKernel using/first_kernel.cpp SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/sphinx/snippets/cpp)
 add_nvqpp_test(FirstObserve using/first_observe.cpp SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/sphinx/snippets/cpp)
 add_nvqpp_test(FirstSample using/first_sample.cpp SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/sphinx/snippets/cpp)
 add_nvqpp_test(Timing using/time.cpp SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/sphinx/snippets/cpp APPLICATION_ARGS "10")

diff --git a/pr-1728/_images/Bloch_sphere.png b/pr-1728/_images/Bloch_sphere.png
diff --git a/pr-1728/_images/examples_python_tutorials_readout_error_mitigation_21_0.png b/pr-1728/_images/examples_python_tutorials_readout_error_mitigation_21_0.png
diff --git a/pr-1728/_images/examples_python_tutorials_readout_error_mitigation_27_1.png b/pr-1728/_images/examples_python_tutorials_readout_error_mitigation_27_1.png
diff --git a/pr-1728/_images/examples_python_tutorials_readout_error_mitigation_28_0.png b/pr-1728/_images/examples_python_tutorials_readout_error_mitigation_28_0.png
diff --git a/pr-1728/_images/examples_python_tutorials_readout_error_mitigation_32_0.png b/pr-1728/_images/examples_python_tutorials_readout_error_mitigation_32_0.png
diff --git a/pr-1728/_images/examples_python_tutorials_readout_error_mitigation_35_0.png b/pr-1728/_images/examples_python_tutorials_readout_error_mitigation_35_0.png
diff --git a/pr-1728/_sources/api/default_ops.rst.txt b/pr-1728/_sources/api/default_ops.rst.txt
@@ -351,10 +351,6 @@ This operation applies the universal three-parameters operator to target qubit.
  // | exp(iφ) * sin(θ/2) exp(i(λ + φ)) * cos(θ/2) |
  u3(M_PI, M_PI, M_PI_2, q);
 
-.. note:: 
-
- The `u3` operation is currently supported in simulation only.
-
 
 Adjoint and Controlled Operations
 ==================================

diff --git a/pr-1728/_sources/api/languages/cpp_api.rst.txt b/pr-1728/_sources/api/languages/cpp_api.rst.txt
@@ -51,7 +51,28 @@ Common
 .. doxygenclass:: cudaq::sample_result
  :members:
 
-.. doxygentypedef:: cudaq::State
+.. doxygenclass:: cudaq::SimulationState
+
+.. doxygenstruct:: cudaq::SimulationState::Tensor
+ :members:
+
+.. doxygenenum:: cudaq::SimulationState::precision
+
+.. doxygenenum:: cudaq::simulation_precision
+
+.. doxygentypedef:: cudaq::tensor
+
+.. doxygentypedef:: cudaq::TensorStateData
+
+.. doxygentypedef:: cudaq::state_data
+
+.. doxygenclass:: cudaq::CusvState
+
+.. doxygenclass:: nvqir::MPSSimulationState
+
+.. doxygenclass:: nvqir::TensorNetSimulationState
+
+.. doxygenclass:: cudaq::RemoteSimulationState
 
 .. doxygenclass:: cudaq::registry::RegisteredType
  :members:
@@ -72,7 +93,6 @@ Common
 
 Noise Modeling 
 ================
-.. doxygentypedef:: cudaq::complex
 
 .. doxygenstruct:: cudaq::kraus_op
  :members:
@@ -151,6 +171,8 @@ Platform
 .. doxygenclass:: cudaq::quantum_platform
  :members:
 
+.. doxygenclass:: cudaq::SerializedCodeExecutionContext
+
 .. doxygentypedef:: cudaq::QuantumTask
 
 .. doxygentypedef:: cudaq::QubitConnectivity
@@ -162,6 +184,10 @@ Platform
 Utilities
 =========
 
+.. doxygentypedef:: cudaq::complex
+
+.. doxygentypedef:: cudaq::real 
+
 .. doxygenfunction:: cudaq::range(std::size_t)
 
 Namespaces 

diff --git a/pr-1728/_sources/api/languages/python_api.rst.txt b/pr-1728/_sources/api/languages/python_api.rst.txt
@@ -87,12 +87,17 @@ Backend Configuration
 Data Types
 =============================
 
+.. autoclass:: cudaq::SimulationPrecision
+ :members:
+
 .. autoclass:: cudaq::Target
  :members:
 
 .. autoclass:: cudaq::State
  :members:
 
+.. autoclass:: cudaq::Tensor
+
 .. autoclass:: cudaq::QuakeValue
 
  .. automethod:: __add__

diff --git a/pr-1728/_sources/examples/python/tutorials/cost_minimization.ipynb.txt b/pr-1728/_sources/examples/python/tutorials/cost_minimization.ipynb.txt
@@ -48,14 +48,14 @@
  "# Initialize a kernel/ ansatz and variational parameters.\n",
  "@cudaq.kernel\n",
  "def kernel(angles: List[float]):\n",
- " # Allocate a qubit that is initialised to the |0> state.\n",
+ " # Allocate a qubit that is initialized to the |0> state.\n",
  " qubit = cudaq.qubit()\n",
  " # Define gates and the qubits they act upon.\n",
  " rx(angles[0], qubit)\n",
  " ry(angles[1], qubit)\n",
  "\n",
  "\n",
- "# Our hamiltonian will be the Z expectation value of our qubit.\n",
+ "# Our Hamiltonian will be the Z expectation value of our qubit.\n",
  "hamiltonian = cudaq.spin.z(0)\n",
  "\n",
  "# Initial gate parameters which intialize the qubit in the zero state\n",

diff --git a/pr-1728/_sources/examples/python/tutorials/deutschs_algorithm.ipynb.txt b/pr-1728/_sources/examples/python/tutorials/deutschs_algorithm.ipynb.txt
@@ -32,7 +32,7 @@
  "metadata": {},
  "outputs": [],
  "source": [
- "# Treat the code snippet below like a black box, i.e you dont have access to the value of the property argument and can just query f with different inputs.\n",
+ "# Treat the code snippet below like a black box, i.e you don't have access to the value of the property argument and can just query f with different inputs.\n",
  "\n",
  "\n",
  "def f(x, property='constant'):\n",

diff --git a/pr-1728/_sources/examples/python/tutorials/executing_circuits.ipynb.txt b/pr-1728/_sources/examples/python/tutorials/executing_circuits.ipynb.txt