google-tpu1 库允许访问 Google TPU 服务的所有功能。

本文档是从 TPU crate 版本 5.0.5+20240613 生成的，其中 20240613 是由 mako 代码生成器 v5.0.5 构建的 tpu:v1 架构的确切版本。

有关 TPU v1 API 的其他信息，请参阅 官方文档网站。

功能

轻松从中央 hub ...

• 处理以下 资源
• 获取位置加速器类型，列出位置加速器类型，获取位置，列出位置，创建位置节点，删除位置节点，获取位置节点，列出位置节点，重置位置节点镜像，启动位置节点，停止位置节点，取消位置操作，删除位置操作，获取位置操作，列出位置操作，获取位置TensorFlow版本和列出位置TensorFlow版本

本库结构

API结构如下主要项目

• 中心
  • 一个中心对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，这些构建器反过来允许访问单个调用构建器
• 资源
  • 可以将活动应用于的主要类型
  • 属性和部分的集合
  • 部分
    • 属性的集合
    • 在活动中从不直接使用
• 活动
  • 应用于资源的操作

所有结构都带有适用特性和标记，以进一步分类它们并便于浏览。

一般来说，您可以像这样调用活动

let r = hub.resource().activity(...).doit().await

或者具体地说 ...

let r = hub.projects().locations_nodes_create(...).doit().await
let r = hub.projects().locations_nodes_delete(...).doit().await
let r = hub.projects().locations_nodes_reimage(...).doit().await
let r = hub.projects().locations_nodes_start(...).doit().await
let r = hub.projects().locations_nodes_stop(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await

resource()和activity(...)调用创建构建器。第二个构建器处理活动，支持各种方法来配置即将进行的操作（此处未显示）。它设计成所有必需的参数都必须立即指定（即(...)），而所有可选的参数都可以按需构建。doit()方法执行与服务器实际通信并返回相应的结果。

用法

设置您的项目

要使用此库，您会将以下行放入您的Cargo.toml文件中

[dependencies]
google-tpu1 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_tpu1 as tpu1;
use tpu1::api::Node;
use tpu1::{Result, Error};
use std::default::Default;
use tpu1::{TPU, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = TPU::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Node::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().locations_nodes_create(req, "parent")
             .node_id("magna")
             .doit().await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

处理错误

系统产生的所有错误都通过doit()方法的返回值，作为Result枚举提供，或者作为可能的中途结果传递给Hub Delegate或Authenticator Delegate。

当代理处理错误或中间值时，它们有机会指导系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

如果一个方法支持下载，你应该读取响应体来获取媒体，这是Result的一部分。如果该方法还支持Response Result，它将默认返回。你可以将其视为实际媒体元数据。要触发媒体下载，你需要通过以下调用设置构建器：.param("alt", "media")。

支持上传的方法可以使用最多2种不同的协议：简单和可恢复。每种协议的独特性通过定制的doit(...)方法表示，分别命名为upload(...)和upload_resumable(...)。

定制和回调

通过在最终调用doit()之前向Method Builder()提供一个代理，您可以修改doit()方法的调用方式。相应的函数将被调用以提供进度信息，并确定系统在失败时应否重试。

delegate trait具有默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

此库提供的所有结构都是为了通过json进行编码和解码而设计的。使用可选参数来表示部分请求或响应是有效的。大多数可选参数都是被视为Parts的，可以按名称标识，将被发送到服务器，以指示请求的设置部分或所需的响应部分。

构建器参数

使用CallBuilder()，您可以通过反复调用其方法来准备一个动作调用。这些方法始终接受单个参数，以下陈述对其适用。

• PODs通过复制传递
• 字符串作为&str传递
• request values被移动

参数将始终被复制或克隆到构建器中，以使其与其原始的生命周期独立。

Cargo功能

• utoipa - 添加对 utoipa 的支持，并为所有类型推导 utoipa::ToSchema。您必须在 #[openapi(schemas(...))] 中导入并注册所需类型，否则生成的 openapi 规范将无效。

许可证

tpu1 库由 Sebastian Thiel 创建，并置于 MIT 许可之下。您可以在存储库的 许可证文件 中阅读全文。