InferenceJob
- class InferenceJob(job_pb, owner, device, model, date, inputs, project_id)
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
submit_inference_job(), orget_job().- date
The time this job was submitted.
- Type:
datetime
- disable_sharing()
Disable all sharing for this job.
- 戻り値の型:
None
- download_artifacts_for_type(output_dir, artifact_type)
Downloads all artifacts of a given type for this job.
If the job is not yet complete, this function will block until completion. If the requested artifact type is not available, returns an empty list. Existing files in the output directory will be overwritten.
- パラメータ:
output_dir (str) -- Directory to save artifacts to. Created if it does not exist.
artifact_type (JobArtifactType) -- The type of artifact to download.
- 戻り値:
Paths to the downloaded artifact files.
- 戻り値の型:
list[str]
- download_job_logs(output_dir)
Downloads all available log artifacts for this job.
If the job is not yet complete, this function will block until completion.
- パラメータ:
output_dir (str) -- Directory to save log files to. Created if it does not exist.
- 戻り値:
Paths to the downloaded log files.
- 戻り値の型:
list[str]
- 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.
- 戻り値の型:
- get_available_artifacts()
Returns the list of artifact types available for download on this job.
If the job is not yet complete, this function will block until completion.
注釈
The availability of specific artifact types may change without notice.
- 戻り値:
Available artifact types.
- 戻り値の型:
list[JobArtifactType]
- 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]
- 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.