Skip to main content
IBM Quantum Platform

Opções

class qiskit.providers.Options(**kwargs)

GitHub

Bases: Mapping

Objeto de opções de base

Essa classe é a base de todas as opções de back-end. As propriedades da classe devem ser ajustáveis dinamicamente para que um usuário possa reconfigurar o backend sob demanda. Se uma propriedade for imutável para o usuário (por exemplo, algo como o número de qubits), isso deverá ser uma configuração da própria classe de backend em vez das opções.

As instâncias dessa classe se comportam como dicionários. O acesso a uma opção com um valor padrão pode ser feito com o método get():

>>> options = Options(opt1=1, opt2=2)
>>> options.get("opt1")
1
>>> options.get("opt3", default="hello")
'hello'

Os pares de valores-chave de todas as opções podem ser recuperados usando o método items():

>>> list(options.items())
[('opt1', 1), ('opt2', 2)]

As opções podem ser atualizadas por nome:

>>> options["opt1"] = 3
>>> options.get("opt1")
3

Os validadores de tempo de execução podem ser registrados. Consulte set_validator. As atualizações por meio de update_options e indexação (__setitem__) validam o novo valor antes de executar a atualização e geram ValueError se o novo valor for inválido.

>>> options.set_validator("opt1", (1, 5))
>>> options["opt1"] = 4
>>> options["opt1"]
4
>>> options["opt1"] = 10
Traceback (most recent call last):
...
ValueError: ...

Atributos

validator


Métodos

get

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

items

items() → a set-like object providing a view on D's items

keys

keys() → a set-like object providing a view on D's keys

set_validator

set_validator(field, validator_value)

GitHub

Definir um validador opcional para um campo nas opções

A definição de um validador permite que as alterações nos valores de uma opção sejam validadas quanto à exatidão quando o update_options() for chamado. Por exemplo, se você tiver um campo numérico como shots , poderá especificar uma tupla de limites que defina um limite superior e um limite inferior para o valor, como, por exemplo, :

options.set_validator("shots", (1, 4096))

Nesse caso, sempre que a opção "shots" for atualizada pelo usuário, ela exigirá que o valor seja >=1 e <=4096. O endereço ValueError será acionado se estiver fora desses limites. Se um validador já estiver presente para o campo especificado, ele será silenciosamente substituído.

Parâmetros

  • field (str) – O nome do campo para definir o validador
  • validator_value (list ortuple ortype) – O valor a ser usado pelo validador, dependendo do tipo, determina como o valor de um campo é verificado. Se for passado um tuplo, ele deve ter comprimento igual a dois e respeitará os valores mínimo e máximo (inclusive) para uma opção de valor inteiro ou flutuante. Se for uma lista, ela exibirá os valores válidos para um campo. Se for um, type o validador apenas garantirá que o valor seja de um determinado tipo.

**Levanta-se

  • KeyError - Se o campo não estiver presente no objeto de opções
  • ValueError - Se o site validator_value tiver um valor inválido para um determinado tipo
  • TypeError - Se validator_value não for um tipo válido

update_options

update_options(**fields)

GitHub

Atualizar opções com kwargs

values

values() → an object providing a view on D's values

Esta página foi útil?
Relate um bug, erro de digitação ou solicite conteúdo no GitHub.