Skip to content

Commit

Permalink
update docs of gitpython
Browse files Browse the repository at this point in the history
Signed-off-by: Zhiyuan Chen <[email protected]>
  • Loading branch information
ZhiyuanChen committed Apr 4, 2023
1 parent c8e6a7f commit af9c18e
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions danling/runner/bases.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,10 @@ class RunnerBase:
uuid: `uuid5(self.run_id, self.id)`.
name: `f"{self.experiment_name}-{self.run_name}"`.
experiment_id: git hash of the current HEAD.
Defaults to `"xxxxxxxxxxxxxxxx"` if Runner not under a git repo.
Defaults to `"xxxxxxxxxxxxxxxx"` if Runner not under a git repo or git/gitpython not installed.
experiment_uuid: UUID of `self.experiment_id`.
Defaults to `UUID('78787878-7878-7878-7878-787878787878')` if Runner not under a git repo.
Defaults to `UUID('78787878-7878-7878-7878-787878787878')`
if Runner not under a git repo or git/gitpython not installed.
experiment_name: Defaults to `"DanLing"`.
run_id: hex of `self.run_uuid`.
run_uuid: `uuid5(self.experiment_id, config.jsons())`.
Expand Down

0 comments on commit af9c18e

Please sign in to comment.