Cloud TPU: Node.js Client

tpu client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG .

• Cloud TPU Node.js Client API Reference
• Cloud TPU Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-tpu

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained .

Table of contents:

• Quickstart
  • Before you begin
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project .
2. Enable billing for your project .
3. Enable the Cloud TPU API .
4. Set up authentication so you can access the API from your local workstation.

Installing the client library

 npm install @google-cloud/tpu 

Using the client library

 // Imports the Google Cloud client library

// remove this line after package is released
// eslint-disable-next-line node/no-missing-require
const {TpuClient} = require(' @google-cloud/tpu 
');

// TODO(developer): replace with your prefered project ID.
// const projectId = 'my-project'

// Creates a client
const client = new TpuClient 
();

async function listNodes() {
  const nodes = await client.listNodes({
    parent: `projects/${projectId}/locations/${location}`,
  });
  console.info(nodes);
}
listNodes(); 

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Tpu.create_node	source code
Tpu.delete_node	source code
Tpu.get_accelerator_type	source code
Tpu.get_node	source code
Tpu.get_tensor_flow_version	source code
Tpu.list_accelerator_types	source code
Tpu.list_nodes	source code
Tpu.list_tensor_flow_versions	source code
Tpu.reimage_node	source code
Tpu.start_node	source code
Tpu.stop_node	source code
Tpu.create_node	source code
Tpu.create_queued_resource	source code
Tpu.delete_node	source code
Tpu.delete_queued_resource	source code
Tpu.generate_service_identity	source code
Tpu.get_accelerator_type	source code
Tpu.get_guest_attributes	source code
Tpu.get_node	source code
Tpu.get_queued_resource	source code
Tpu.get_runtime_version	source code
Tpu.list_accelerator_types	source code
Tpu.list_nodes	source code
Tpu.list_queued_resources	source code
Tpu.list_runtime_versions	source code
Tpu.reset_queued_resource	source code
Tpu.start_node	source code
Tpu.stop_node	source code
Tpu.update_node	source code
Tpu.create_node	source code
Tpu.create_queued_resource	source code
Tpu.delete_node	source code
Tpu.delete_queued_resource	source code
Tpu.generate_service_identity	source code
Tpu.get_accelerator_type	source code
Tpu.get_guest_attributes	source code
Tpu.get_node	source code
Tpu.get_queued_resource	source code
Tpu.get_runtime_version	source code
Tpu.list_accelerator_types	source code
Tpu.list_nodes	source code
Tpu.list_queued_resources	source code
Tpu.list_reservations	source code
Tpu.list_runtime_versions	source code
Tpu.perform_maintenance	source code
Tpu.perform_maintenance_queued_resource	source code
Tpu.reset_queued_resource	source code
Tpu.simulate_maintenance_event	source code
Tpu.start_node	source code
Tpu.stop_node	source code
Tpu.update_node	source code
Quickstart	source code

The Cloud TPU Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule . Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

• Legacy versions are not tested in continuous integration.
• Some security patches and features cannot be backported.
• Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags . The dist-tags follow the naming convention legacy-(version) . For example, npm install @google-cloud/tpu@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning .

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stablelibraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide .

Please note that this README.md , the samples/README.md , and a variety of configuration files in this repository (including .nycrc and tsconfig.json ) are generated from a central template. To edit one of these files, make an edit to its templates in directory .

License

Apache Version 2.0

See LICENSE