tensorcircuit.cloud.apis

main entrypoints of cloud module

tensorcircuit.cloud.apis.b64decode_s(s: str) → str[source]
tensorcircuit.cloud.apis.b64encode_s(s: str) → str[source]
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:

_description_

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) – _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: str | Provider | None = None, device: str | Device | None = None) → Task[source]

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: str | Task, token: str | None = None, prettify: bool = False) → Dict[str, Any][source]

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: str | Provider | None = None, device: str | Device | None = None) → str | None[source]

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: str | Provider | None = None, token: str | None = None, **kws: Any) → List[Device][source]

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: str | Provider | None = None, device: str | Device | None = None, token: str | None = None) → Dict[str, Any][source]

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[Provider][source]

list all cloud providers that tensorcircuit supports

Returns:

_description_

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][source]

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: str | Task | None, token: str | None = None) → Task[source]
tensorcircuit.cloud.apis.resubmit_task(task: str | Task | None, token: str | None = None) → Task[source]

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: str | Provider | None = None, device: str | Device | None = None, set_global: bool = True) → Device[source]

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: str | Provider | None = None, set_global: bool = True) → Provider[source]

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: str | None = None, provider: str | Provider | None = None, device: str | Device | None = None, cached: bool = True, clear: bool = False) → Dict[str, Any][source]

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: str | Provider | None = None, device: str | Device | None = None, token: str | None = None, **task_kws: Any) → List[Task][source]

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]