ProfileJob

class ProfileJob(job_pb, owner, device, model, date, shapes)

Profile job for a model, a set of input specs, and a device.

A profile job should not be constructed directly. It is constructed by the hub client through qai_hub.submit_profile_job(), or qai_hub.get_job().

device

The device on which the model is being profiled.

Type:

Device

model

The model for the job.

Type:

Model

date

The time this job was submitted.

Type:

datetime

shapes

The input specs for the model.

Type:

InputSpecs

disable_sharing()

Disable all sharing for this job.

반환 형식:

None

download_profile(filename=None)

Returns the downloaded profile, either in memory or as a file.

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

매개변수:

filename (Optional[str]) – If filename is specified the profile is downloaded to file, otherwise to memory.

반환:

The downloaded profile results as a dict, or filename of a downloaded yaml file containing the profile results

반환 형식:

Dict | str

download_results(artifacts_dir)

Returns all the results of a job.

This includes the profile and the compiled target model.

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.

반환 형식:

ProfileJobResult

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.