Estimate Data Loading
Estimate the time and cost of a data-loading job before submitting it.
Use this tool to size a data-loading run up front, for example to choose a qubit count or layer count that fits a time budget. It creates no job and spends no credits.
When to Use:
- Call this before
load_classical_data_with_data_loadingwhen the user asks how long loading will take or what it will cost. - Call this to compare qubit or layer counts before committing to one.
Constraints:
- Only
DistributionLoadingandVectorLoadinghave resource models. Other modes accepted byload_classical_data_with_data_loadingcannot be estimated and are rejected with422. - The estimate depends only on
num_qubitsandnum_layers; the actual data payload does not change it.
Notes:
- Report the estimate in seconds and credits, and state plainly that it is an estimate rather than a quote.
Args: user: Authenticated user resolved from the API key. data: Loading mode, qubit count, and mode parameters to estimate.
Returns: The estimated time and cost with an explanatory context string.
Authorizations
Body
Define payload for estimating a data-loading job.
Attributes:
dl_type: Data-loading mode. Only the two modes with resource models
implemented are accepted.
num_qubits: Target qubit count for the loaded state.
parameters: Mode-specific parameters; only num_layers affects the
estimate today.
Data loading mode to estimate. Only DistributionLoading and VectorLoading have resource models; the other modes accepted by load_classical_data_with_data_loading cannot be estimated yet.
DistributionLoading, VectorLoading Target qubit count for the loaded state.
x >= 1Mode-specific parameters. Only num_layers currently affects the estimate.
Response
Successful Response
Represent a pre-submission time and cost estimate.
Attributes: estimated_time: Estimated wall-clock computation time in seconds. estimated_cost: Estimated cost in Haiqu credits. context: Summary of what the estimate covers and how to act on it.