TpuClient
(
*
,
credentials
:
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
Optional
[
Union
[
str
,
google
.
cloud
.
tpu_v1
.
services
.
tpu
.
transports
.
base
.
TpuTransport
]]
=
None
,
client_options
:
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
client_info
:
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
=
< google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
object
> )
Manages TPU nodes and other resources TPU API v1
Properties
transport
Returns the transport used by the client instance.
TpuTransport
Methods
TpuClient
TpuClient
(
*
,
credentials
:
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
Optional
[
Union
[
str
,
google
.
cloud
.
tpu_v1
.
services
.
tpu
.
transports
.
base
.
TpuTransport
]]
=
None
,
client_options
:
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
client_info
:
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
=
< google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
object
> )
Instantiates the tpu client.
credentials
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport
Union[str, TpuTransport]
The transport to use. If set to None, a transport is chosen automatically.
client_options
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a transport
instance is provided. (1) The api_endpoint
property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source
property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
client_info
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If None
, then default info will be used. Generally, you only need to set this if you're developing your own client library.
google.auth.exceptions.MutualTLSChannelError
__exit__
__exit__
(
type
,
value
,
traceback
)
Releases underlying transport's resources.
accelerator_type_path
accelerator_type_path
(
project
:
str
,
location
:
str
,
accelerator_type
:
str
)
Returns a fully-qualified accelerator_type string.
common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path
(
folder
:
str
)
Returns a fully-qualified folder string.
common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
Returns a fully-qualified location string.
common_organization_path
common_organization_path
(
organization
:
str
)
Returns a fully-qualified organization string.
common_project_path
common_project_path
(
project
:
str
)
Returns a fully-qualified project string.
create_node
create_node
(
request
:
Optional
[
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
CreateNodeRequest
,
dict
]]
=
None
,
*
,
parent
:
Optional
[
str
]
=
None
,
node
:
Optional
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
Node
]
=
None
,
node_id
:
Optional
[
str
]
=
None
,
retry
:
google
.
api_core
.
retry
.
Retry
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
Creates a node.
request
Union[ google.cloud.tpu_v1.types.CreateNodeRequest
, dict]
The request object. Request for CreateNode .
parent
str
Required. The parent resource name. This corresponds to the parent
field on the request
instance; if request
is provided, this should not be set.
node
google.cloud.tpu_v1.types.Node
Required. The node. This corresponds to the node
field on the request
instance; if request
is provided, this should not be set.
node_id
str
The unqualified resource name. This corresponds to the node_id
field on the request
instance; if request
is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.api_core.operation.Operation
delete_node
delete_node
(
request
:
Optional
[
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
DeleteNodeRequest
,
dict
]]
=
None
,
*
,
name
:
Optional
[
str
]
=
None
,
retry
:
google
.
api_core
.
retry
.
Retry
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
Deletes a node.
request
Union[ google.cloud.tpu_v1.types.DeleteNodeRequest
, dict]
The request object. Request for DeleteNode .
name
str
Required. The resource name. This corresponds to the name
field on the request
instance; if request
is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.api_core.operation.Operation
from_service_account_file
from_service_account_file
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
filename
str
The path to the service account private key json file.
TpuClient
from_service_account_info
from_service_account_info
(
info
:
dict
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials info.
info
dict
The service account private key info.
TpuClient
from_service_account_json
from_service_account_json
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
filename
str
The path to the service account private key json file.
TpuClient
get_accelerator_type
get_accelerator_type
(
request
:
Optional
[
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
GetAcceleratorTypeRequest
,
dict
]]
=
None
,
*
,
name
:
Optional
[
str
]
=
None
,
retry
:
google
.
api_core
.
retry
.
Retry
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
Gets AcceleratorType.
request
Union[ google.cloud.tpu_v1.types.GetAcceleratorTypeRequest
, dict]
The request object. Request for GetAcceleratorType .
name
str
Required. The resource name. This corresponds to the name
field on the request
instance; if request
is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
get_node
get_node
(
request
:
Optional
[
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
GetNodeRequest
,
dict
]]
=
None
,
*
,
name
:
Optional
[
str
]
=
None
,
retry
:
google
.
api_core
.
retry
.
Retry
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
Gets the details of a node.
request
name
str
Required. The resource name. This corresponds to the name
field on the request
instance; if request
is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
get_tensor_flow_version
get_tensor_flow_version
(
request
:
Optional
[
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
GetTensorFlowVersionRequest
,
dict
]]
=
None
,
*
,
name
:
Optional
[
str
]
=
None
,
retry
:
google
.
api_core
.
retry
.
Retry
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
Gets TensorFlow Version.
request
Union[ google.cloud.tpu_v1.types.GetTensorFlowVersionRequest
, dict]
The request object. Request for GetTensorFlowVersion .
name
str
Required. The resource name. This corresponds to the name
field on the request
instance; if request
is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
list_accelerator_types
list_accelerator_types
(
request
:
Optional
[
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
ListAcceleratorTypesRequest
,
dict
]]
=
None
,
*
,
parent
:
Optional
[
str
]
=
None
,
retry
:
google
.
api_core
.
retry
.
Retry
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
Lists accelerator types supported by this API.
request
Union[ google.cloud.tpu_v1.types.ListAcceleratorTypesRequest
, dict]
The request object. Request for ListAcceleratorTypes .
parent
str
Required. The parent resource name. This corresponds to the parent
field on the request
instance; if request
is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
list_nodes
list_nodes
(
request
:
Optional
[
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
ListNodesRequest
,
dict
]]
=
None
,
*
,
parent
:
Optional
[
str
]
=
None
,
retry
:
google
.
api_core
.
retry
.
Retry
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
Lists nodes.
request
Union[ google.cloud.tpu_v1.types.ListNodesRequest
, dict]
The request object. Request for ListNodes .
parent
str
Required. The parent resource name. This corresponds to the parent
field on the request
instance; if request
is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
list_tensor_flow_versions
list_tensor_flow_versions
(
request
:
Optional
[
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
ListTensorFlowVersionsRequest
,
dict
]]
=
None
,
*
,
parent
:
Optional
[
str
]
=
None
,
retry
:
google
.
api_core
.
retry
.
Retry
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
List TensorFlow versions supported by this API.
request
Union[ google.cloud.tpu_v1.types.ListTensorFlowVersionsRequest
, dict]
The request object. Request for ListTensorFlowVersions .
parent
str
Required. The parent resource name. This corresponds to the parent
field on the request
instance; if request
is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
node_path
node_path
(
project
:
str
,
location
:
str
,
node
:
str
)
Returns a fully-qualified node string.
parse_accelerator_type_path
parse_accelerator_type_path
(
path
:
str
)
Parses a accelerator_type path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path
(
path
:
str
)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path
(
path
:
str
)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path
(
path
:
str
)
Parse a project path into its component segments.
parse_node_path
parse_node_path
(
path
:
str
)
Parses a node path into its component segments.
parse_tensor_flow_version_path
parse_tensor_flow_version_path
(
path
:
str
)
Parses a tensor_flow_version path into its component segments.
reimage_node
reimage_node
(
request
:
Optional
[
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
ReimageNodeRequest
,
dict
]]
=
None
,
*
,
retry
:
google
.
api_core
.
retry
.
Retry
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
Reimages a node's OS.
request
Union[ google.cloud.tpu_v1.types.ReimageNodeRequest
, dict]
The request object. Request for ReimageNode .
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.api_core.operation.Operation
start_node
start_node
(
request
:
Optional
[
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
StartNodeRequest
,
dict
]]
=
None
,
*
,
retry
:
google
.
api_core
.
retry
.
Retry
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
Starts a node.
request
Union[ google.cloud.tpu_v1.types.StartNodeRequest
, dict]
The request object. Request for StartNode .
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.api_core.operation.Operation
stop_node
stop_node
(
request
:
Optional
[
Union
[
google
.
cloud
.
tpu_v1
.
types
.
cloud_tpu
.
StopNodeRequest
,
dict
]]
=
None
,
*
,
retry
:
google
.
api_core
.
retry
.
Retry
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
Stops a node.
request
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.api_core.operation.Operation
tensor_flow_version_path
tensor_flow_version_path
(
project
:
str
,
location
:
str
,
tensor_flow_version
:
str
)
Returns a fully-qualified tensor_flow_version string.