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: Optional[Union[str, tensorcircuit.cloud.abstraction.Provider]] = None, device: Optional[Union[str, tensorcircuit.cloud.abstraction.Device]] = None, *, set_global: bool = False) → tensorcircuit.cloud.abstraction.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

_description_

Return type

Device

tensorcircuit.cloud.apis.get_provider(provider: Optional[Union[str, tensorcircuit.cloud.abstraction.Provider]] = None, *, set_global: bool = False) → tensorcircuit.cloud.abstraction.Provider

set default provider for the program

Parameters

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

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

Returns

_description_

Return type

Provider

tensorcircuit.cloud.apis.get_task(taskid: str, provider: Optional[Union[str, tensorcircuit.cloud.abstraction.Provider]] = None, device: Optional[Union[str, tensorcircuit.cloud.abstraction.Device]] = None) → tensorcircuit.cloud.abstraction.Task

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

Parameters

• taskid (str) – _description_

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

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

Returns

_description_

Return type

Task

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

Get task details dict given task id

Parameters

• taskid (Union[str, Task]) – _description_

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

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

Returns

_description_

Return type

Dict[str, Any]

tensorcircuit.cloud.apis.get_token(provider: Optional[Union[str, tensorcircuit.cloud.abstraction.Provider]] = None, device: Optional[Union[str, tensorcircuit.cloud.abstraction.Device]] = None) → Optional[str]

Get API token setted for given provider or device, if no device token saved, the corresponding provider tken is returned

Parameters

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

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

Returns

_description_

Return type

Optional[str]

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

List all devices under a provider

Parameters

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

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

Returns

_description_

Return type

Any

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

List properties of a given device

Parameters

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

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

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

Returns

Propeties dict

Return type

Dict[str, Any]

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

list all cloud providers that tensorcircuit supports

Returns

_description_

Return type

List[Provider]

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

List tasks based on given filters

Parameters

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

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

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

Returns

list of task object that satisfy these filter criteria

Return type

List[Task]

tensorcircuit.cloud.apis.remove_task(task: Optional[Union[str, tensorcircuit.cloud.abstraction.Task]], token: Optional[str] = None) → tensorcircuit.cloud.abstraction.Task

tensorcircuit.cloud.apis.resubmit_task(task: Optional[Union[str, tensorcircuit.cloud.abstraction.Task]], token: Optional[str] = None) → tensorcircuit.cloud.abstraction.Task

Rerun the given task

Parameters

• task (Optional[Union[str, Task]]) – _description_

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

Returns

_description_

Return type

Task

tensorcircuit.cloud.apis.set_device(provider: Optional[Union[str, tensorcircuit.cloud.abstraction.Provider]] = None, device: Optional[Union[str, tensorcircuit.cloud.abstraction.Device]] = None, set_global: bool = True) → tensorcircuit.cloud.abstraction.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

_description_

Return type

Device

tensorcircuit.cloud.apis.set_provider(provider: Optional[Union[str, tensorcircuit.cloud.abstraction.Provider]] = None, set_global: bool = True) → tensorcircuit.cloud.abstraction.Provider

set default provider for the program

Parameters

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

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

Returns

_description_

Return type

Provider

tensorcircuit.cloud.apis.set_token(token: Optional[str] = None, provider: Optional[Union[str, tensorcircuit.cloud.abstraction.Provider]] = None, device: Optional[Union[str, tensorcircuit.cloud.abstraction.Device]] = 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) – _description_, defaults to None

• device (Optional[Union[str, Device]], optional) – _description_, 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

_description_

Return type

Dict[str, Any]

tensorcircuit.cloud.apis.submit_task(provider: Optional[Union[str, tensorcircuit.cloud.abstraction.Provider]] = None, device: Optional[Union[str, tensorcircuit.cloud.abstraction.Device]] = None, token: Optional[str] = None, **task_kws: Any) → List[tensorcircuit.cloud.abstraction.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) – _description_, defaults to None

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

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

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

Returns

The task object

Return type

List[Task]