cirq_google.engine.get_engine_sampler

See Stable See Nightly

View source on GitHub

Get an EngineSampler assuming some sensible defaults.

View aliases

Main aliases

cirq_google.engine.engine.engine_sampler.get_engine_sampler, cirq_google.engine.engine_sampler.get_engine_sampler, cirq_google.get_engine_sampler

cirq_google.engine.get_engine_sampler(
    processor_id: str, gate_set_name: str, project_id: Optional[str] = None
) -> 'cirq_google.QuantumEngineSampler'

This uses the environment variable GOOGLE_CLOUD_PROJECT for the Engine project_id, unless set explicitly.

Args
processor_id	Engine processor ID (from Cloud console or <a href="../../cirq_google/engine/Engine#list_processors"><code>Engine.list_processors</code></a>).
gate_set_name	One of ['sqrt_iswap', 'sycamore']. See cirq_google.NAMED_GATESETS.
project_id	Optional explicit Google Cloud project id. Otherwise, this defaults to the environment variable GOOGLE_CLOUD_PROJECT. By using an environment variable, you can avoid hard-coding personal project IDs in shared code.

Returns
A QuantumEngineSampler instance.

Raises
ValueError	If the supplied gate set is not a supported gate set name.
EnvironmentError	If no project_id is specified and the environment variable GOOGLE_CLOUD_PROJECT is not set.