Jobs Client - NVIDIA/clara-platform-python-client GitHub Wiki

This client is utilized for managing clara jobs, which includes creating, starting, listing, and cancelling jobs.

>>> from nvidia_clara.jobs_client import JobsClient
>>> import nvidia_clara.job_types as job_types
>>> import nvidia_clara.pipeline_types as pipeline_types

# Client Creation with IP and Port of running instance of Clara
>>> clara_ip_address = "10.0.0.1"
>>> clara_port = "30031"

>>> jobs_client = JobsClient(target=clara_ip_address, port=clara_port)

# Creates Filter of Healthy Jobs - Additionally could filter by Pipeline Id, State, Completion Time, and Creation Time
>>> job_filter = job_types.JobFilter(has_job_status=[job_types.JobStatus.Healthy])

# List Current Jobs with Optional Filter
>>> job_list = jobs_client.list_jobs(job_filter=job_filter)
[<job_types.JobInfo object at 0x058908E0>, <job_types.JobInfo object at 0x063208E0>]

# Identifier of created pipeline (ex. colon tumor segmentation)
>>> colon_tumor_pipeline_id = "dd05c5b79461402cb0a610d4f0fce36f"

# Create Job
>>> job_info = jobs_client.create_job(job_name="colontumor",pipeline_id=pipeline_types.PipelineId(colon_tumor_pipeline_id))
<job_types.JobInfo object at 0x05369B78>

>>> job_info.job_id.value
'3a4edd810b4b4945be4d34c4c57bfb67'

# Start Job
>>> job_token = jobs_client.start_job(job_id=job_info.job_id)
<job_types.JobToken object at 0x05373B78>

>>> job_token.job_state
1

>>> job_token.job_status
1

# Gets List of Operators
>>> job_details.operator_details.keys()
["colon-tumor-segmentation","dicom-reader","dicom-writer","register-dicom-output","register-volume-images-for-rendering"]

# Get Status of Job from Identifier
>>> job_details = jobs_client.get_status(job_id=job_token.job_id)
<job_types.JobDetails object at 0x05373B78>

>>> job_details.job_state
1

>>> job_details.job_status
1

# Try Canceling Job (if still running)
>>> job_details = jobs_client.cancel_job(job_id=job_token.job_id)