133 lines
5.0 KiB
Python
133 lines
5.0 KiB
Python
# Copyright 2018 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.
|
|
|
|
|
|
import sys
|
|
import subprocess
|
|
import time
|
|
import json
|
|
import click
|
|
import shutil
|
|
|
|
from .output import print_output, OutputFormat
|
|
|
|
|
|
@click.group()
|
|
def run():
|
|
"""manage run resources"""
|
|
pass
|
|
|
|
|
|
@run.command()
|
|
@click.option('-e', '--experiment-id', help='Parent experiment ID of listed runs.')
|
|
@click.option('-m', '--max-size', default=100, help='Max size of the listed runs.')
|
|
@click.pass_context
|
|
def list(ctx, experiment_id, max_size):
|
|
"""list recent KFP runs"""
|
|
client = ctx.obj['client']
|
|
output_format = ctx.obj['output']
|
|
response = client.list_runs(experiment_id=experiment_id, page_size=max_size, sort_by='created_at desc')
|
|
if response and response.runs:
|
|
_print_runs(response.runs, output_format)
|
|
else:
|
|
if output_format == OutputFormat.json.name:
|
|
msg = json.dumps([])
|
|
else:
|
|
msg = 'No runs found.'
|
|
click.echo(msg)
|
|
|
|
|
|
@run.command()
|
|
@click.option('-e', '--experiment-name', required=True, help='Experiment name of the run.')
|
|
@click.option('-r', '--run-name', help='Name of the run.')
|
|
@click.option('-f', '--package-file', type=click.Path(exists=True, dir_okay=False),
|
|
help='Path of the pipeline package file.')
|
|
@click.option('-p', '--pipeline-id', help='ID of the pipeline template.')
|
|
@click.option('-n', '--pipeline-name', help='Name of the pipeline template.')
|
|
@click.option('-w', '--watch', is_flag=True, default=False,
|
|
help='Watch the run status until it finishes.')
|
|
@click.option('-v', '--version', help='ID of the pipeline version.')
|
|
@click.argument('args', nargs=-1)
|
|
@click.pass_context
|
|
def submit(ctx, experiment_name, run_name, package_file, pipeline_id, pipeline_name, watch,
|
|
version, args):
|
|
"""submit a KFP run"""
|
|
client = ctx.obj['client']
|
|
namespace = ctx.obj['namespace']
|
|
output_format = ctx.obj['output']
|
|
if not run_name:
|
|
run_name = experiment_name
|
|
|
|
if not pipeline_id and pipeline_name:
|
|
pipeline_id = client.get_pipeline_id(name=pipeline_name)
|
|
|
|
if not package_file and not pipeline_id and not version:
|
|
click.echo('You must provide one of [package_file, pipeline_id, version].', err=True)
|
|
sys.exit(1)
|
|
|
|
arg_dict = dict(arg.split('=') for arg in args)
|
|
experiment = client.create_experiment(experiment_name)
|
|
run = client.run_pipeline(experiment.id, run_name, package_file, arg_dict, pipeline_id,
|
|
version_id=version)
|
|
_display_run(client, namespace, run.id, watch, output_format)
|
|
|
|
|
|
@run.command()
|
|
@click.option('-w', '--watch', is_flag=True, default=False,
|
|
help='Watch the run status until it finishes.')
|
|
@click.argument('run-id')
|
|
@click.pass_context
|
|
def get(ctx, watch, run_id):
|
|
"""display the details of a KFP run"""
|
|
client = ctx.obj['client']
|
|
namespace = ctx.obj['namespace']
|
|
output_format = ctx.obj['output']
|
|
_display_run(client, namespace, run_id, watch, output_format)
|
|
|
|
|
|
def _display_run(client, namespace, run_id, watch, output_format):
|
|
run = client.get_run(run_id).run
|
|
_print_runs([run], output_format)
|
|
if not watch:
|
|
return
|
|
argo_path = shutil.which('argo')
|
|
if not argo_path:
|
|
raise RuntimeError("argo isn't found in $PATH. It's necessary for watch. "
|
|
"Please make sure it's installed and available. "
|
|
"Installation instructions be found here - "
|
|
"https://github.com/argoproj/argo/releases")
|
|
|
|
argo_workflow_name = None
|
|
while True:
|
|
time.sleep(1)
|
|
run_detail = client.get_run(run_id)
|
|
run = run_detail.run
|
|
if run_detail.pipeline_runtime and run_detail.pipeline_runtime.workflow_manifest:
|
|
manifest = json.loads(run_detail.pipeline_runtime.workflow_manifest)
|
|
if manifest['metadata'] and manifest['metadata']['name']:
|
|
argo_workflow_name = manifest['metadata']['name']
|
|
break
|
|
if run_detail.run.status in ['Succeeded', 'Skipped', 'Failed', 'Error']:
|
|
click.echo('Run is finished with status {}.'.format(run_detail.run.status))
|
|
return
|
|
if argo_workflow_name:
|
|
subprocess.run([argo_path, 'watch', argo_workflow_name, '-n', namespace])
|
|
_print_runs([run], output_format)
|
|
|
|
|
|
def _print_runs(runs, output_format):
|
|
headers = ['run id', 'name', 'status', 'created at']
|
|
data = [[run.id, run.name, run.status, run.created_at.isoformat()] for run in runs]
|
|
print_output(data, headers, output_format, table_format='grid')
|