Skip to main content
IBM Quantum Platform
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.

qiskit.providers.ibmq.runtime.ParameterNamespace

class ParameterNamespace(params)

GitHub

A namespace for program parameters with validation.

This class provides a namespace for program parameters with auto-completion and validation support.

ParameterNamespace constructor.

Parameters

params (List[ProgramParameter]) – The program’s input parameters.

__init__

__init__(params)

ParameterNamespace constructor.

Parameters

params (List[ProgramParameter]) – The program’s input parameters.


Methods

__init__(params)ParameterNamespace constructor.
validate()Validate program input values.

Attributes

metadataReturns the parameter metadata

metadata

Returns the parameter metadata

Return type

List[ProgramParameter]

validate

validate()

Validate program input values.

Note

This method only verifies that required parameters have values. It does not fail the validation if the namepsace has extraneous parameters.

Raises

IBMQInputValueError if validation fails

Return type

None

Was this page helpful?
Report a bug or request content on GitHub.