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

参数

  • 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

返回

_description_

返回类型

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

参数

  • 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

返回

_description_

返回类型

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

参数

  • taskid (str) -- _description_

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

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

返回

_description_

返回类型

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

参数

  • 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

返回

_description_

返回类型

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

参数

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

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

返回

_description_

返回类型

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

参数

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

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

返回

_description_

返回类型

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

参数

  • 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

返回

Propeties dict

返回类型

Dict[str, Any]

tensorcircuit.cloud.apis.list_providers() → List[tensorcircuit.cloud.abstraction.Provider][源代码]#

list all cloud providers that tensorcircuit supports

返回

_description_

返回类型

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

参数

  • 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

返回

list of task object that satisfy these filter criteria

返回类型

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

参数

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

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

返回

_description_

返回类型

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

参数

  • 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

返回

_description_

返回类型

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

参数

  • 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

返回

_description_

返回类型

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

参数

  • 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

返回

_description_

返回类型

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

参见

tensorcircuit.cloud.tencent.submit_task()

参数

  • 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()

返回

The task object

返回类型

List[Task]