Skip to content

feat(tpu): add tpu queued resources create spot #9615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Dec 20, 2024
103 changes: 103 additions & 0 deletions tpu/src/main/java/tpu/CreateSpotQueuedResource.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package tpu;

// [START tpu_queued_resources_create_spot]
import com.google.cloud.tpu.v2alpha1.CreateQueuedResourceRequest;
import com.google.cloud.tpu.v2alpha1.Node;
import com.google.cloud.tpu.v2alpha1.QueuedResource;
import com.google.cloud.tpu.v2alpha1.SchedulingConfig;
import com.google.cloud.tpu.v2alpha1.TpuClient;
import java.io.IOException;
import java.util.concurrent.ExecutionException;

public class CreateSpotQueuedResource {
public static void main(String[] args)
throws IOException, ExecutionException, InterruptedException {
// TODO(developer): Replace these variables before running the sample.
// Project ID or project number of the Google Cloud project you want to create a node.
String projectId = "YOUR_PROJECT_ID";
// The zone in which to create the TPU.
// For more information about supported TPU types for specific zones,
// see https://cloud.google.com/tpu/docs/regions-zones
String zone = "us-central1-f";
// The name for your TPU.
String nodeName = "YOUR_TPU_NAME";
// The accelerator type that specifies the version and size of the Cloud TPU you want to create.
// For more information about supported accelerator types for each TPU version,
// see https://cloud.google.com/tpu/docs/system-architecture-tpu-vm#versions.
String tpuType = "v2-8";
// Software version that specifies the version of the TPU runtime to install.
// For more information see https://cloud.google.com/tpu/docs/runtimes
String tpuSoftwareVersion = "tpu-vm-tf-2.14.1";
// The name for your Queued Resource.
String queuedResourceId = "QUEUED_RESOURCE_ID";

createQueuedResource(
projectId, zone, queuedResourceId, nodeName, tpuType, tpuSoftwareVersion);
}

// Creates a Queued Resource with --preemptible flag.
public static QueuedResource createQueuedResource(
String projectId, String zone, String queuedResourceId,
String nodeName, String tpuType, String tpuSoftwareVersion)
throws IOException, ExecutionException, InterruptedException {
// Initialize client that will be used to send requests. This client only needs to be created
// once, and can be reused for multiple requests.
try (TpuClient tpuClient = TpuClient.create()) {
String parent = String.format("projects/%s/locations/%s", projectId, zone);
String resourceName = String.format("projects/%s/locations/%s/queuedResources/%s",
projectId, zone, queuedResourceId);
SchedulingConfig schedulingConfig = SchedulingConfig.newBuilder()
.setPreemptible(true)
.build();

Node node =
Node.newBuilder()
.setName(nodeName)
.setAcceleratorType(tpuType)
.setRuntimeVersion(tpuSoftwareVersion)
.setSchedulingConfig(schedulingConfig)
.setQueuedResource(resourceName)
.build();

QueuedResource queuedResource =
QueuedResource.newBuilder()
.setName(queuedResourceId)
.setTpu(
QueuedResource.Tpu.newBuilder()
.addNodeSpec(
QueuedResource.Tpu.NodeSpec.newBuilder()
.setParent(parent)
.setNode(node)
.setNodeId(nodeName)
.build())
.build())
.build();

CreateQueuedResourceRequest request =
CreateQueuedResourceRequest.newBuilder()
.setParent(parent)
.setQueuedResourceId(queuedResourceId)
.setQueuedResource(queuedResource)
.build();

return tpuClient.createQueuedResourceAsync(request).get();
}
}
}
// [END tpu_queued_resources_create_spot]
26 changes: 26 additions & 0 deletions tpu/src/test/java/tpu/QueuedResourceIT.java
Original file line number Diff line number Diff line change
Expand Up @@ -136,4 +136,30 @@ public void testCreateQueuedResourceWithStartupScript() throws Exception {
assertEquals(returnedQueuedResource, mockQueuedResource);
}
}

@Test
public void testCreateSpotQueuedResource() throws Exception {
try (MockedStatic<TpuClient> mockedTpuClient = mockStatic(TpuClient.class)) {
QueuedResource mockQueuedResource = QueuedResource.newBuilder()
.setName("QueuedResourceName")
.build();
TpuClient mockedClientInstance = mock(TpuClient.class);
OperationFuture mockFuture = mock(OperationFuture.class);

mockedTpuClient.when(TpuClient::create).thenReturn(mockedClientInstance);
when(mockedClientInstance.createQueuedResourceAsync(any(CreateQueuedResourceRequest.class)))
.thenReturn(mockFuture);
when(mockFuture.get()).thenReturn(mockQueuedResource);

QueuedResource returnedQueuedResource =
CreateSpotQueuedResource.createQueuedResource(
PROJECT_ID, ZONE, QUEUED_RESOURCE_NAME, NODE_NAME,
TPU_TYPE, TPU_SOFTWARE_VERSION);

verify(mockedClientInstance, times(1))
.createQueuedResourceAsync(any(CreateQueuedResourceRequest.class));
verify(mockFuture, times(1)).get();
assertEquals(returnedQueuedResource.getName(), mockQueuedResource.getName());
}
}
}
Loading