tensorcircuit.cloud.apis

main entrypoints of cloud module

tensorcircuit.cloud.apis.b64decode_s(s: str) → str

tensorcircuit.cloud.apis.b64encode_s(s: str) → str

tensorcircuit.cloud.apis.get_device(provider: str | Provider | None = None, device: str | Device | None = None, *, set_global: bool = False) → Device

set the default device

Parameters:

• provider (Optional[Union[str, Provider]], optional) – provider of the device, defaults to None

• device (Optional[Union[str, Device]], optional) – the device, defaults to None

• set_global (bool, optional) – whether set, defaults to True, if False, equivalent to get_device, defaults to True

Returns:

the resolved Device

Return type:

Device

tensorcircuit.cloud.apis.get_provider(provider: str | Provider | None = None, *, set_global: bool = False) → Provider

set default provider for the program

Parameters:

• provider (Optional[Union[str, Provider]], optional) – provider name or Provider instance; defaults to None which means the current default provider

• set_global (bool, optional) – whether set, defaults to True, if False, equivalent to get_provider

Returns:

the resolved Provider

Return type:

Provider

tensorcircuit.cloud.apis.get_task(taskid: str, provider: str | Provider | None = None, device: str | Device | None = None) → Task

Get Task object from task string, the binding device can also be provided

Parameters:

• taskid (str) – task id string, optionally prefixed with the device via the sep2 separator

• provider (Optional[Union[str, Provider]], optional) – provider name or Provider instance; defaults to None

• device (Optional[Union[str, Device]], optional) – device name or Device instance; defaults to None

Returns:

the resolved Task object

Return type:

Task

tensorcircuit.cloud.apis.get_task_details(taskid: str | Task, token: str | None = None, prettify: bool = False) → Dict[str, Any]

Get task details dict given task id

Parameters:

• taskid (Union[str, Task]) – task id string or Task object

• token (Optional[str], optional) – API token for the provider; defaults to None which uses the saved token

• prettify (bool) – whether make the returned dict more readable and more phythonic, defaults to False

Returns:

task details dict (raw or prettified)

Return type:

Dict[str, Any]

tensorcircuit.cloud.apis.get_token(provider: str | Provider | None = None, device: str | Device | None = None) → str | None

Get API token setted for given provider or device, if no device token saved, the corresponding provider tken is returned. Environment variables take precedence and are never persisted: a single token can be supplied via TC_TOKEN, or a per-provider token via TC_TOKEN_<PROVIDER_NAME> (uppercased), e.g. TC_TOKEN_TENCENT.

Parameters:

• provider (Optional[Union[str, Provider]], optional) – provider scope to look up; defaults to the current default provider

• device (Optional[Union[str, Device]], optional) – device scope to look up; defaults to None

Returns:

the matching token, or None if no token is set

Return type:

Optional[str]

tensorcircuit.cloud.apis.list_devices(provider: str | Provider | None = None, token: str | None = None, **kws: Any) → List[Device]

List all devices under a provider

Parameters:

• provider (Optional[Union[str, Provider]], optional) – provider name or Provider instance; defaults to None

• token (Optional[str], optional) – API token for the provider; defaults to None which uses the saved token

Returns:

list of Device objects under the provider

Return type:

Any

tensorcircuit.cloud.apis.list_properties(provider: str | Provider | None = None, device: str | Device | None = None, token: str | None = None) → Dict[str, Any]

List properties of a given device

Parameters:

• provider (Optional[Union[str, Provider]], optional) – provider name or Provider instance; defaults to None

• device (Optional[Union[str, Device]], optional) – device name or Device instance; defaults to None

• token (Optional[str], optional) – API token for the provider; defaults to None which uses the saved token

Returns:

Propeties dict

Return type:

Dict[str, Any]

tensorcircuit.cloud.apis.list_providers() → List[Provider]

list all cloud providers that tensorcircuit supports

Returns:

list of all supported Provider objects

Return type:

List[Provider]

tensorcircuit.cloud.apis.list_tasks(provider: str | Provider | None = None, device: str | Device | None = None, token: str | None = None, **filter_kws: Any) → List[Task]

List tasks based on given filters

Parameters:

• provider (Optional[Union[str, Provider]], optional) – provider name or Provider instance; defaults to None

• device (Optional[Union[str, Device]], optional) – device name or Device instance; defaults to None

• token (Optional[str], optional) – API token for the provider; defaults to None which uses the saved token

Returns:

list of task object that satisfy these filter criteria

Return type:

List[Task]

tensorcircuit.cloud.apis.remove_task(task: str | Task | None, token: str | None = None) → Task

tensorcircuit.cloud.apis.resubmit_task(task: str | Task | None, token: str | None = None) → Task

Rerun the given task

Parameters:

• task (Optional[Union[str, Task]]) – task id string or Task object to rerun

• token (Optional[str], optional) – API token for the provider; defaults to None which uses the saved token

Returns:

the newly submitted Task

Return type:

Task

tensorcircuit.cloud.apis.set_device(provider: str | Provider | None = None, device: str | Device | None = None, set_global: bool = True) → Device

set the default device

Parameters:

• provider (Optional[Union[str, Provider]], optional) – provider of the device, defaults to None

• device (Optional[Union[str, Device]], optional) – the device, defaults to None

• set_global (bool, optional) – whether set, defaults to True, if False, equivalent to get_device, defaults to True

Returns:

the resolved Device

Return type:

Device

tensorcircuit.cloud.apis.set_provider(provider: str | Provider | None = None, set_global: bool = True) → Provider

set default provider for the program

Parameters:

• provider (Optional[Union[str, Provider]], optional) – provider name or Provider instance; defaults to None which means the current default provider

• set_global (bool, optional) – whether set, defaults to True, if False, equivalent to get_provider

Returns:

the resolved Provider

Return type:

Provider

tensorcircuit.cloud.apis.set_token(token: str | None = None, provider: str | Provider | None = None, device: str | Device | None = None, cached: bool = True, clear: bool = False) → Dict[str, Any]

Set API token for given provider or specifically to given device

Parameters:

• token (Optional[str], optional) – the API token, defaults to None

• provider (Optional[Union[str, Provider]], optional) – provider scope of the token; defaults to None

• device (Optional[Union[str, Device]], optional) – device scope of the token (more specific than provider); defaults to None

• cached (bool, optional) – whether save on the disk, defaults to True

• clear (bool, optional) – if True, clear all token saved, defaults to False

Returns:

the session-level saved_token dict

Return type:

Dict[str, Any]

tensorcircuit.cloud.apis.submit_task(provider: str | Provider | None = None, device: str | Device | None = None, token: str | None = None, **task_kws: Any) → List[Task]

submit task to the cloud platform, batch submission default enabled

See also

tensorcircuit.cloud.tencent.submit_task()

Parameters:

• provider (Optional[Union[str, Provider]], optional) – provider name or Provider instance; defaults to None

• device (Optional[Union[str, Device]], optional) – device name or Device instance; defaults to None

• token (Optional[str], optional) – API token for the provider; defaults to None which uses the saved token

• task_kws (Any) – all necessary keywords arguments for task submission, see detailed API in each provider backend: 1. tencent - tensorcircuit.cloud.tencent.submit_task() 2. tianyan - tensorcircuit.cloud.tianyan.submit_task()

Returns:

Task object or list of Task for batch submission

Return type:

List[Task]