EnvironmentVariables

braket.jobs.environment_variables.get_job_name()[source]

Get the name of the current job.

Return type:

str

Returns:

str – The name of the job if in a job, else an empty string.

braket.jobs.environment_variables.get_job_device_arn()[source]

Get the device ARN of the current job. If not in a job, default to “local:none/none”.

Return type:

str

Returns:

str – The device ARN of the current job or “local:none/none”.

braket.jobs.environment_variables.get_input_data_dir(channel='input')[source]

Get the job input data directory.

Parameters:

channel (str) – The name of the input channel. Default value corresponds to the default input channel name, input.

Return type:

str

Returns:

str – The input directory, defaulting to current working directory.

braket.jobs.environment_variables.get_results_dir()[source]

Get the job result directory.

Return type:

str

Returns:

str – The results directory, defaulting to current working directory.

braket.jobs.environment_variables.get_checkpoint_dir()[source]

Get the job checkpoint directory.

Return type:

str

Returns:

str – The checkpoint directory, defaulting to current working directory.

braket.jobs.environment_variables.get_hyperparameters()[source]

Get the job hyperparameters as a dict, with the values stringified.

Return type:

dict[str, str]

Returns:

dict[str, str] – The hyperparameters of the job.