braket.jobs.environment_variables module

braket.jobs.environment_variables.get_job_name() → str

Get the name of the current job.

Returns:

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

braket.jobs.environment_variables.get_job_device_arn() → str

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

Returns:

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

braket.jobs.environment_variables.get_input_data_dir(channel: str = 'input') → str

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.

Returns:

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

braket.jobs.environment_variables.get_results_dir() → str

Get the job result directory.

Returns:

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

braket.jobs.environment_variables.get_checkpoint_dir() → str

Get the job checkpoint directory.

Returns:

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

braket.jobs.environment_variables.get_hyperparameters() → dict[str, str]

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

Returns:

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