This is an automated email from the ASF dual-hosted git repository.
400Ping pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/mahout.git
The following commit(s) were added to refs/heads/main by this push:
new 28bab6e86 docs: add QDP source API docstrings (#1404)
28bab6e86 is described below
commit 28bab6e869452def1687c602e034a60e10737a24
Author: Vic Wen <[email protected]>
AuthorDate: Tue Jun 16 11:06:34 2026 +0800
docs: add QDP source API docstrings (#1404)
---
qdp/qdp-python/qumat_qdp/backend.py | 8 ++++++++
qdp/qdp-python/qumat_qdp/loader.py | 10 ++++++++++
qdp/qdp-python/qumat_qdp/tensor.py | 1 +
3 files changed, 19 insertions(+)
diff --git a/qdp/qdp-python/qumat_qdp/backend.py
b/qdp/qdp-python/qumat_qdp/backend.py
index 42f105172..498609f4a 100644
--- a/qdp/qdp-python/qumat_qdp/backend.py
+++ b/qdp/qdp-python/qumat_qdp/backend.py
@@ -93,6 +93,14 @@ class QdpEngine:
precision: str = "float32",
backend: str = "cuda",
) -> None:
+ """Create a backend-selecting QDP engine facade.
+
+ :param device_id: GPU device ordinal to use.
+ :param precision: Numeric precision requested from the backend.
+ :param backend: Backend selector, either ``"cuda"``, ``"amd"``, or
+ ``"triton_amd"``.
+ :raises ValueError: If ``backend`` is not supported.
+ """
self.device_id = device_id
self.precision = precision
self.backend, self._engine_adapter = _select_engine_adapter(
diff --git a/qdp/qdp-python/qumat_qdp/loader.py
b/qdp/qdp-python/qumat_qdp/loader.py
index 8f05affe7..cc01a405c 100644
--- a/qdp/qdp-python/qumat_qdp/loader.py
+++ b/qdp/qdp-python/qumat_qdp/loader.py
@@ -271,6 +271,16 @@ class QuantumDataLoader:
encoding_method: str = "amplitude",
seed: int | None = None,
) -> None:
+ """Create a loader builder with default synthetic batching settings.
+
+ :param device_id: GPU device ordinal used by native and PyTorch
backends.
+ :param num_qubits: Number of qubits in each encoded output state.
+ :param batch_size: Number of samples per emitted batch.
+ :param total_batches: Maximum number of batches to emit.
+ :param encoding_method: Encoding method name.
+ :param seed: Optional synthetic data seed.
+ :raises ValueError: If any initial setting is invalid.
+ """
_validate_loader_args(
device_id=device_id,
num_qubits=num_qubits,
diff --git a/qdp/qdp-python/qumat_qdp/tensor.py
b/qdp/qdp-python/qumat_qdp/tensor.py
index bdabf931b..986109fa0 100644
--- a/qdp/qdp-python/qumat_qdp/tensor.py
+++ b/qdp/qdp-python/qumat_qdp/tensor.py
@@ -85,4 +85,5 @@ class QdpTensor:
return torch.from_dlpack(self)
+#: Backward-compatible alias for :class:`QdpTensor`.
QuantumTensor = QdpTensor
