Skip to main contentIBM Quantum Documentation

ParameterNamespace

ParameterNamespace(parameters)

A namespace for program parameters with validation.

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

ParameterNamespace constructor.

Parameters

parameters (Dict) – The program’s input parameters.


Attributes

metadata

Returns the parameter metadata

Return type

Dict


Methods

to_dict

to_dict()

Convert to dictionary.

Return type

Dict

validate

validate()

Validate program input values.

Note

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

Raises

IBMInputValueError – if validation fails

Return type

None

Was this page helpful?