InferenceJob

class InferenceJob(job_pb, owner, device, model, date, inputs)

Inference job for a model, user provided inputs, and a device.

An inference job should not be constructed directly. It is constructed by the hub client through qai_hub.submit_inference_job(), or qai_hub.get_job().

device

The device for this job.

Type:

Device

model

The model for the job.

Type:

Model

date

The time this job was submitted.

Type:

datetime

inputs

The inputs provided by user.

Type:

Dataset

disable_sharing()

Disable all sharing for this job.

戻り値の型:

None

download_output_data(filename=None)

Returns the downloaded output data, either in memory or as a h5f file.

If the job is not ready, this function will block until completion.

パラメータ:

filename (Optional[str]) -- If filename is specified the output data is downloaded to file, otherwise to memory.

戻り値:

The downloaded output data, filename, or None if the job failed.

戻り値の型:

DatasetEntries | str | None

download_results(artifacts_dir)

Returns all the results of an inference job.

If the job is not ready, this function will block until completion.

パラメータ:

artifacts_dir (str) -- Directory name where the job artifacts are stored. If the directory does not exist, it is created.

戻り値:

Job results.

戻り値の型:

InferenceJobResult

get_output_dataset()

Returns the output dataset for a job.

If the job is not ready, this function will block until completion.

戻り値:

The output data if the job succeeded

戻り値の型:

Dataset | None

get_sharing()

Get the list of email addresses of users that this job has been shared with.

戻り値の型:

List[str]

get_status()

Returns the status of a job.

戻り値:

The status of the job

戻り値の型:

JobStatus

modify_sharing(add_emails=[], delete_emails=[])

Modifies the list of users that the job is shared with.

All assets (models, datasets, artifacts, etc.) associated with the job will also be shared. For inference and profile jobs, the corresponding compile and link jobs (if any) will also be shared.

戻り値の型:

None

set_name(job_name)

Sets the name of a job to the specified value.

戻り値の型:

None

property url: str

Returns the URL for the job.

戻り値:

The URL for the job.

戻り値の型:

str

wait(timeout=None)

Block until this job finishes.

パラメータ:

timeout (Optional[int]) --

If provided, a TimeoutError will be raised after waiting this many seconds.

If None, this client will not time out the job, meaning it will block an indefinite amount of time waiting for the job to finish.

HOWEVER, Qualcomm AI Hub will fail / time out any job a set amount of time after its creation. Therefore, even if timeout is None, the runtime of this method will still have a finite upper bound.

戻り値:

The final, "finished" (SUCCESS or FAILED) status for this job.

戻り値の型:

str

例外:

TimeoutError -- Raised only if a client-side timeout occurs, when param "timeout" != None. If the Qualcomm AI Hub server times out the job, this error will NOT be raised, and a FAILED job status will be returned instead.