Skip to content

Commit

Permalink
docs: Add run custom job on persistent resource sample.
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 621913789
  • Loading branch information
vertex-sdk-bot authored and Copybara-Service committed Apr 4, 2024
1 parent 33d2b4d commit 31100c6
Show file tree
Hide file tree
Showing 2 changed files with 108 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# 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
#
# https://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.


from google.cloud import aiplatform


# [START aiplatform_sdk_create_custom_job_on_persistent_resource_sample]
def create_custom_job_on_persistent_resource_sample(
project: str,
location: str,
staging_bucket: str,
display_name: str,
container_uri: str,
persistent_resource_id: str,
service_account: str,
) -> None:
aiplatform.init(
project=project, location=location, staging_bucket=staging_bucket
)

worker_pool_specs = [{
"machine_spec": {
"machine_type": "n1-standard-4",
"accelerator_type": "NVIDIA_TESLA_K80",
"accelerator_count": 1,
},
"replica_count": 1,
"container_spec": {
"image_uri": container_uri,
"command": [],
"args": [],
},
}]

custom_job = aiplatform.CustomJob(
display_name=display_name,
worker_pool_specs=worker_pool_specs,
persistent_resource_id=persistent_resource_id,
)

custom_job.run(service_account=service_account)


# [END aiplatform_sdk_create_custom_job_on_persistent_resource_sample]
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# 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
#
# https://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.


import create_custom_job_on_persistent_resource_sample
import test_constants as constants


_PRESISTENT_RESOURCE_ID = "test_persistent_resource_id"


def test_create_custom_job_on_persistent_resource_sample(
mock_sdk_init,
mock_get_custom_job,
mock_run_custom_job,
):
create_custom_job_on_persistent_resource_sample.create_custom_job_on_persistent_resource_sample(
project=constants.PROJECT,
location=constants.LOCATION,
staging_bucket=constants.STAGING_BUCKET,
display_name=constants.DISPLAY_NAME,
container_uri=constants.CONTAINER_URI,
persistent_resource_id=_PRESISTENT_RESOURCE_ID,
service_account=constants.SERVICE_ACCOUNT,
)

mock_sdk_init.assert_called_once_with(
project=constants.PROJECT,
location=constants.LOCATION,
staging_bucket=constants.STAGING_BUCKET,
)

mock_get_custom_job.assert_called_once_with(
display_name=constants.DISPLAY_NAME,
worker_pool_specs=constants.CUSTOM_JOB_WORKER_POOL_SPECS,
persistent_resource_id=_PRESISTENT_RESOURCE_ID,
)

mock_run_custom_job.assert_called_once_with(
service_account=constants.SERVICE_ACCOUNT,
)

0 comments on commit 31100c6

Please sign in to comment.