Skip to content

Commit

Permalink
docs: fix helper docstring (#725)
Browse files Browse the repository at this point in the history
  • Loading branch information
ajberdy authored Oct 4, 2023
1 parent 7977b94 commit ba6bb52
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/braket/jobs/environment_variables.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ def get_results_dir() -> str:
def get_checkpoint_dir() -> str:
"""
Get the job checkpoint directory.
Returns:
str: The checkpoint directory, defaulting to current working directory.
"""
Expand All @@ -61,9 +62,10 @@ def get_checkpoint_dir() -> str:

def get_hyperparameters() -> Dict[str, str]:
"""
Get the job checkpoint directory.
Get the job hyperparameters as strings.
Returns:
str: The checkpoint directory, defaulting to current working directory.
Dict[str, str]: The hyperparameters of the job.
"""
if "AMZN_BRAKET_HP_FILE" in os.environ:
with open(os.getenv("AMZN_BRAKET_HP_FILE"), "r") as f:
Expand Down

0 comments on commit ba6bb52

Please sign in to comment.