#tpu #google #protocols #google-api #web #web-api #api

google-tpu1_alpha1

一个完整的库,用于与 TPU (协议 v1alpha1) 交互

19 个稳定版本 (4 个主要版本)

5.0.5+20240613 2024年6月27日
5.0.4+20240222 2024年3月5日
5.0.3+20230105 2023年8月24日
5.0.2+20230105 2023年3月17日
1.0.7+20171121 2017年12月12日

#2525 in 网页开发

Download history 7/week @ 2024-05-17 3/week @ 2024-05-24 81/week @ 2024-06-21 34/week @ 2024-06-28 10/week @ 2024-07-05

1,135 个月下载量
用于 google-tpu1_alpha1-cli

MIT 许可证

335KB
4.5K SLoC

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

本文档是从 TPU 库版本 5.0.5+20240613 生成的,其中 20240613 是由 mako 代码生成器 v5.0.5 构建的 tpu:v1alpha1 方案的精确版本。

有关 TPU v1_alpha1 API 的其他所有信息,请参阅 官方文档站点

功能

从中央 中心 简单地处理以下 资源 ...

本库结构

API结构如下主要项目

  • Hub
  • 资源
    • 主要类型,可以将活动应用于其中
    • 一系列属性和部分
    • 部分
      • 一系列属性
      • 活动中从未直接使用
  • 活动
    • 应用于资源的操作

所有结构都标有适用特性和进一步分类,便于浏览。

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

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(...) 调用创建构建器。第二个与Activities相关,支持各种方法来配置即将进行的操作(此处未显示)。它被设计成必须立即指定所有必需的参数(即(...)),而所有可选的参数可以按需构建doit()方法执行与服务器实际通信并返回相应结果。

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_tpu1_alpha1 as tpu1_alpha1;
use tpu1_alpha1::api::Node;
use tpu1_alpha1::{Result, Error};
use std::default::Default;
use tpu1_alpha1::{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")
             .request_id("magna")
             .node_id("no")
             .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),
}

错误处理

系统产生的所有错误都作为Result枚举类型返回值,或者作为中间结果传递给Hub DelegateAuthenticator Delegate

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

上传和下载

如果方法支持下载,您应该读取响应体(它是Result的一部分),以获取媒体。如果此类方法还支持Response Result,则默认返回该结果。您可以将它视为实际媒体的元数据。要触发媒体下载,您必须通过以下调用设置构建器:.param("alt", "media")

支持上传的方法可以使用最多两种不同的协议进行上传:简单可重试。每种协议的独特性通过定制的doit(...)方法表示,这些方法分别命名为upload(...)upload_resumable(...)

定制和回调

您可以通过在调用最终的doit()调用之前向方法构建器提供一个代理来更改调用doit()方法的方式。相应的调用将被调用以提供进度信息,并确定在失败时系统是否应该重试。

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

服务器请求中的可选部分

此库提供的所有结构都旨在通过json进行编码和解码。可选项用于表示部分请求或响应是有效的。大多数可选项都是Parts,可以通过名称识别,这些名称将被发送到服务器以指示请求或响应中所需的设置部分。

构建器参数

通过使用方法构建器,您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受单个参数,对于以下陈述是正确的。

  • PODs通过复制传递
  • 字符串作为&str传递
  • 请求值被移动

参数将始终被复制或克隆到构建器中,以确保它们与其原始生命周期无关。

Cargo 功能

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

许可证

tpu1_alpha1 库由 Sebastian Thiel 生成,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。

依赖项

~12-23MB
~342K SLoC