Utilitários

qiskit.utils.add_deprecation_to_docstring(func, msg, *, since, pending)

Insira dinamicamente a mensagem de depreciação na docstring de func.

Parâmetros

• func (Callable) – A função a ser modificada.
• msg (str) – A mensagem completa de depreciação.
• since (str | None) – A versão em que a depreciação começou.
• pending (bool) – A depreciação ainda está pendente?

Tipo de retorno

Nenhum

qiskit.utils.deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='Qiskit', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')

Decorador para indicar que um argumento foi depreciado de alguma forma.

Esse decorador pode ser usado várias vezes na mesma função, uma vez por argumento obsoleto. Ele deve ser colocado abaixo de outros decoradores, como @staticmethod e decoradores de imóveis.

Parâmetros

• name (str) – O nome do argumento obsoleto.
• since (str) – A versão em que a depreciação começou. Se a depreciação estiver pendente, defina a versão para quando ela começou; mas, mais tarde, ao mudar de pendente para depreciada, atualize-a para a nova versão.
• deprecation_description (str | None) – O que está sendo descontinuado? E.g. "Definindo o argumento my_func() de my_arg como None." Se não for definido, o padrão será " {func_name} 's argument {name} ".
• additional_msg (str | None) – Coloque aqui qualquer informação adicional, como o que usar em seu lugar (se new_alias não estiver definido). Por exemplo, "Em vez disso, use o argumento new_arg, que é semelhante, mas não afeta a configuração do circuito."
• pending (bool) – Defina como True se a depreciação ainda estiver pendente.
• package_name (str) – O nome do pacote mostrado na mensagem de depreciação (por exemplo, o nome do pacote PyPI ).
• new_alias (str | None) – Se o arg tiver sido simplesmente renomeado, defina isso como o novo nome. O decorador atualizará dinamicamente os kwargs de modo que, quando o usuário definir o argumento antigo, ele será passado como o argumento new_alias.
• predicate (Callable[[Any], bool] | None) – Registre o aviso de tempo de execução apenas se o predicado retornar Verdadeiro. Isso é útil para depreciar determinados valores ou tipos para um argumento, por exemplo, lambda my_arg: isinstance(my_arg, dict). Independentemente de um predicado estar definido, o aviso de tempo de execução só será registrado quando o usuário especificar o argumento.
• removal_timeline (str) – Em quanto tempo essa depreciação poderá ser removida? Espera um valor como "não antes de 6 meses após a última versão" ou "na versão 9.99 ".

Retorna

O chamável decorado.

Tipo de retorno

Chamável

qiskit.utils.deprecate_func(*, since, additional_msg=None, pending=False, package_name='Qiskit', removal_timeline='no earlier than 3 months after the release date', is_property=False, stacklevel=2)

Decorador para indicar que uma função foi descontinuada.

Ele deve ser colocado abaixo de outros decoradores, como @staticmethod e decoradores de propriedade.

Ao descontinuar uma classe, defina esse decorador em sua função __init___.

Parâmetros

• since (str) – A versão em que a depreciação começou. Se a depreciação estiver pendente, defina a versão para quando ela começou; mas, posteriormente, ao mudar de pendente para depreciada, atualize since para a nova versão.
• additional_msg (str | None) – Coloque aqui qualquer informação adicional, como o que usar em seu lugar. Por exemplo, "Em vez disso, use a função new_func do módulo <my_module>.<my_submodule>, que é semelhante, mas usa aceleração de GPU."
• pending (bool) – Defina como True se a depreciação ainda estiver pendente.
• package_name (str) – O nome do pacote mostrado na mensagem de depreciação (por exemplo, o nome do pacote PyPI ).
• removal_timeline (str) – Em quanto tempo essa depreciação poderá ser removida? Espera um valor como "não antes de 6 meses após a última versão" ou "na versão 9.99 ".
• is_property (bool) – Se a função obsoleta for uma @property, defina este valor como True para que a mensagem gerada a descreva corretamente como tal. (Isso não é necessário para os setters de propriedade, pois sua string de documentação é ignorada pelo Python.)
• stacklevel (int) – Nível de pilha passado para warnings.warn().

Retorna

O chamável decorado.

Tipo de retorno

Chamável

qiskit.utils.apply_prefix(value, unit)

Dado o prefixo e o valor de uma unidade SI, aplique o prefixo para converter para a unidade SI padrão.

Parâmetros

• value (float |ParameterExpression) – O número ao qual aplicar o prefixo.
• unit (str) – Prefixo da cadeia de caracteres.

Retorna

Valor convertido.

Tipo de retorno

flutuante ParameterExpression

Aumentos

ValueError – Se o unit não for reconhecido.

Parâmetros

• value (float |ParameterExpression)
• unit (str)

Tipo de retorno

flutuante ParameterExpression

qiskit.utils.detach_prefix(value, decimal=None)

Dado um valor de unidade SI, encontre o prefixo mais adequado para escalar o valor.

Por exemplo, o value = 1.3e8 será convertido em uma tupla de (130.0, "M"), que representa um valor em escala e uma unidade auxiliar que pode ser usada para exibir o valor. No exemplo acima, esse valor pode ser exibido como 130 MHz (a unidade é arbitrária aqui).

Exemplo

>>> value, prefix = detach_prefix(1e4)
>>> print(f"{value} {prefix}Hz")
10 kHz

Parâmetros

• value (float) – O número para encontrar o prefixo.
• decimal (int | None) – Opcional. Um número inteiro arbitrário para representar a precisão do valor. Se especificado, ele tenta arredondar a mantissa e ajustar o prefixo ao valor arredondado. Por exemplo, 999_999.91 se tornará 999.9999 k com decimal=4, enquanto 1.0 M com decimal=3 ou menos.

Retorna

Uma tupla de valor escalonado e prefixo.

Tipo de retorno

tupla[ float, str ]

Aumentos

• ValueError - Se o value estiver fora da faixa.
• ValueError - Se o value não for um número real.

Parâmetros

• value (float)
• decimal (int | None)

Tipo de retorno

tupla[ float, str ]

qiskit.utils.wrap_method(cls, name, *, before=None, after=None)

Envolva a funcionalidade do método de instância ou classe cls.name com comportamento adicional before e after.

Isso altera cls, substituindo o atributo name pela nova funcionalidade. Isso é útil ao criar decoradores de classe. Em vez disso, é permitido que o método seja definido em qualquer classe principal.

Se before ou after forem fornecidos, eles deverão ser chamáveis com uma assinatura compatível com o método referido. Eles serão chamados imediatamente antes ou depois do método, conforme apropriado, e qualquer valor de retorno será ignorado.

Parâmetros

• cls (type) – a classe a ser modificada.
• name (str) – o nome do método na classe a ser envolvida.
• before (Callable | None) – uma função que deve ser chamada antes do método que está sendo encapsulado.
• after (Callable | None) – uma função que deve ser chamada após o método que está sendo encapsulado.

Aumentos

ValueError - se o método nomeado não estiver definido na classe ou em qualquer classe pai.

qiskit.utils.default_num_processes()

Obtém o número de processos que uma chamada paralela de multiprocessamento usará por padrão.

Normalmente, essas funções também aceitam um argumento de palavra-chave num_processes que substituirá o valor retornado por essa função.

Em ordem de prioridade (da maior para a menor), o valor de retorno será:

1. A variável de ambiente QISKIT_NUM_PROCS , se definida.
2. A chave num_processes do arquivo de configuração do usuário do Qiskit, se definida.
3. Metade das CPUs lógicas disponíveis para esse processo, se isso puder ser determinado. Esse é um substituto para o número de CPUs físicas, pressupondo multithreading simultâneo (SMT) duplo; empiricamente, o desempenho de multiprocessamento do Qiskit parece ser pior quando se tenta usar núcleos SMT.
4. 1, se tudo o mais falhar.

Se um valor configurado pelo usuário for definido como um número menor que 1, ele será tratado como se fosse 1.

Tipo de retorno

int

qiskit.utils.is_main_process()

Verifica se o processo atual é o principal.

Como Python 3.8, isso é idêntico à maneira padrão Python de calcular isso:

>>> import multiprocessing
>>> multiprocessing.parent_process() is None

Essa função foi deixada para compatibilidade com versões anteriores, mas há poucos motivos para não usar as ferramentas internas do Python.

Tipo de retorno

bool

qiskit.utils.local_hardware_info()

Informações básicas de hardware sobre o computador local.

Tenta estimar o número de CPUs físicas na máquina, mesmo quando o hyperthreading está ativado. A contagem da CPU tem como padrão 1 quando a contagem real não pode ser determinada.

Retorna

As informações de hardware.

Tipo de retorno

dict

qiskit.utils.should_run_in_parallel(num_processes=None)

Decidir se uma função de multiprocessamento deve gerar subprocessos para paralelização.

Em particular, é assim que o parallel_map() decide se deve ou não usar o multiprocessamento. O argumento num_processes , por si só, não impõe o paralelismo; por padrão, o Qiskit só usará o paralelismo baseado em processos quando um método de início de geração de processos semelhante ao fork estiver em vigor. Você pode substituir essa decisão definindo o método de início multiprocessing método de inicialização usado, definindo a variável de ambiente QISKIT_PARALLEL como "TRUE" ou definindo parallel = true no arquivo de configurações do usuário.

Essa função inclui dois gerenciadores de contexto que podem ser usados para modificar temporariamente o valor de retorno dessa função:

override

ignore_user_settings

Parâmetros

num_processes (int | None) – o número máximo de processos solicitados para uso (None implica o padrão).

Tipo de retorno

bool

Exemplos

Substitui temporariamente as configurações definidas para desativar o paralelismo:

>>> with should_run_in_parallel.override(True):
...     assert should_run_in_parallel(8)
>>> with should_run_in_parallel.override(False):
...     assert not should_run_in_parallel(8)

qiskit.utils.parallel_map(task, values, task_args=(), task_kwargs=None, num_processes=None)

Execução paralela de um mapeamento de valores para a tarefa de função. Isso é funcionalmente equivalente a:

result = [task(value, *task_args, **task_kwargs) for value in values]

Isso paralelizará os resultados se o número de values for maior que um e should_run_in_parallel() retorna True. Caso contrário, ele será executado em série.

Parâmetros

• task (func) – Função que deve ser chamada para cada valor em values.
• values (array_like) – Lista ou matriz de valores para os quais a função task deve ser avaliada.
• task_args (list) – Argumentos adicionais opcionais para a função task .
• task_kwargs (dict) – Argumento opcional de palavra-chave adicional para a função task .
• num_processes (int) – Número de processos a serem gerados. Se não for fornecido, o valor de retorno de default_num_processes() é usado.

Retorna

A lista de resultados contém o valor de task(value, *task_args, **task_kwargs) para cada valor em values.

Tipo de retorno

Resultado

Exemplos

import time
from qiskit.utils import parallel_map
def func(_):
        time.sleep(0.1)
        return 0
parallel_map(func, list(range(10)));

O Qiskit Aer oferece simuladores de alto desempenho para os circuitos quânticos criados no Qiskit.

O Qiskit IBMQ Provider é usado para acessar o hardware do IBM Quantum na nuvem IBM.

Qiskit Ignis fornece ferramentas para verificação de hardware quântico, caracterização de ruído e correção de erros.

O Qiskit TOQM fornece passagens de transpilador para o algoritmo de mapeamento Time-optimal Qubit.

python-constraint é um solucionador de problemas de satisfação de restrições, usado na passagem do CSPLayout passagem do transpilador.

O CPLEX Optimizer da IBM é um solucionador de programação matemática de alto desempenho para programação linear, mista-inteira e quadrática. Isso não é mais usado pelo Qiskit, mas já foi usado no passado, e a opção permanece por motivos de compatibilidade com versões anteriores.

O CVXPY é um pacote Python para resolver problemas de otimização convexa. Ele é necessário para calcular as normas de diamante com quantum_info.diamond_norm().

IBM Decision Optimization O CPLEX Modelling é uma biblioteca para análise prescritiva. Assim como o CPLEX, essa opção não é mais utilizada pelo Qiskit, mas já foi usada no passado e permanece disponível para fins de compatibilidade com versões anteriores.

O conjunto de testes tem recursos adicionais que estão disponíveis se o módulo opcional de acessórios estiver instalado. Isso geralmente também precisa de HAS_TESTTOOLS também. Geralmente, isso só é necessário para os desenvolvedores do Qiskit.

Se o kernel IPython estiver disponível, algumas visualizações adicionais e mágicas de linha serão disponibilizadas.

Os widgets de monitoramento para trabalhos executados em backends externos podem ser fornecidos se o ipywidgets estiver disponível.

Alguns métodos de cálculo de gradiente em opflow.gradients exigem JAX para autodiferenciação.

Alguns dos testes exigem uma instalação completa do Jupyter para testar os recursos de interatividade.

O Qiskit fornece várias ferramentas de visualização no módulo visualization módulo. Quase todos eles são criados usando o Matplotlib que devem ser instalados para que possam ser usados.

Não é mais usado pela Qiskit. Internamente, o Qiskit agora usa a biblioteca de alto desempenho rustworkx como uma dependência central e, durante o período de mudança, às vezes era conveniente converter as coisas para o formato Python -only NetworkX formato. Alguns testes de módulos de aplicativos, como o Qiskit Nature, ainda usam o site NetworkX.

NLopt é uma biblioteca de otimização não linear, usada pelos otimizadores globais no módulo algorithms.optimizers .

O PIL é uma biblioteca de manipulação de imagens do site Python. Na verdade, o Qiskit usa o pillow fork do PIL se ele estiver disponível ao gerar determinadas visualizações, por exemplo, de ambos QuantumCircuit e DAGCircuit em determinados modos.

Para algumas visualizações de gráficos, o Qiskit usa o pydot como uma interface para GraphViz (consulte HAS_GRAPHVIZ).

O Pygments é um destacador e formatador de código usado por muitos ambientes que envolvem a exibição avançada de blocos de código, incluindo o Sphinx e o Jupyter. O Qiskit usa esse recurso ao produzir um resultado avançado para esses ambientes.

Várias visualizações do site LaTeX-based, especialmente as gavetas de circuitos, precisam acessar o projeto pylatexenc para funcionar corretamente.

As funções qasm3.load() e qasm3.loads() para importar programas do OpenQASM 3 para instâncias do QuantumCircuit instâncias usam um pacote importador externo.

O Qiskit fornece várias ferramentas de visualização no módulo visualization módulo. Alguns deles são criados usando o Seaborn, que deve ser instalado para que possam ser usados.

Algumas das funções de gradiente em opflow.gradients usam métodos de regularização do Scikit Learn.

Alguns dos otimizadores do site algorithms.optimizers são baseados nos encontrados no Scikit Quant, que deve ser instalado para usá-los.

SQSnobFit é uma biblioteca para o algoritmo "stable noisy optimization by branch and fit". Ele é usado pelo otimizador SNOBFIT .

O Symengine é um backend C++ rápido para a biblioteca de manipulação simbólica Sympy. Essa dependência é usada para carregar formatos QPY legados, em que esse pacote foi usado para lidar com Parameters.

SymPy é uma biblioteca do Python para matemática simbólica. SymPy era historicamente usado para a implementação da ParameterExpression classe, mas já não é mais. No entanto, isso é necessário para algumas funcionalidades antigas que utilizam ParameterExpression.sympify(). Também é utilizado em algumas funções de visualização e na correspondência de modelos.

O conjunto de testes do Qiskit tem funcionalidades mais avançadas disponíveis se a biblioteca opcional testtools estiver instalada. Geralmente, isso só é necessário para os desenvolvedores do Qiskit.

Tweedledum é uma biblioteca de extensão para síntese e otimização de circuitos que podem envolver oráculos clássicos. No passado, a Qiskit's PhaseOracle usava esse recurso, mas ele não é mais usado pela Qiskit.

Z3 é um provador de teoremas, usado nas passagens CrosstalkAdaptiveSchedule e HoareOptimizer passagens do transpilador.

Para algumas visualizações de gráficos, o Qiskit usa a ferramenta de visualização GraphViz por meio de sua interface pydot (consulte HAS_PYDOT).

As ferramentas de visualização que usam o LaTeX em sua saída, como as gavetas de circuito, exigem que o pdflatex esteja disponível. Em geral, é necessário garantir que você tenha uma instalação funcional do LaTeX disponível e o pacote qcircuit.tex .

As ferramentas de visualização que convertem arquivos LaTeX-generated em imagens rasterizadas usam a ferramenta pdftocairo . Isso faz parte do conjunto Poppler de ferramentas de PDF.