From d206143982d411f0cc6abef821b1c8497311de3e Mon Sep 17 00:00:00 2001 From: Mikko Kotila Date: Fri, 15 Apr 2022 17:27:35 +0300 Subject: [PATCH] updated docs --- docs/Energy_Draw.md | 16 +++++++++------- docs/_coverpage.md | 2 +- docs/index.html | 2 +- talos/utils/power_draw_append.py | 4 ++-- 4 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/Energy_Draw.md b/docs/Energy_Draw.md index 950e8a4a..4b589071 100644 --- a/docs/Energy_Draw.md +++ b/docs/Energy_Draw.md @@ -7,15 +7,17 @@ A callback for recording GPU power draw (watts) on epoch begin and end. The call ### how-to-use -Use it as you would use any other Callback in Tensorflow or Keras. +Before `model.fit()` in the input model: -` -power_draw = PowerDrawCallback() +`power_draw = PowerDrawCallback()` -model.fit(...callbacks=[power_draw]...) -` +Then use `power_draw` as you would callbacks in general: -It's possible to read the energy draw data: +`model.fit(...callbacks=[power_draw]...)` -`print(power_draw.logs)` +To get the energy draw data into the experiment log: + +`history = talos.utils.power_draw_append(history, power_draw)` + +NOTE: this line has to be after `model.fit()`. diff --git a/docs/_coverpage.md b/docs/_coverpage.md index 89961a9e..5149099e 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -1,6 +1,6 @@ ![logo](_media/talos_logo_bg.png) -## v1.2 +## v1.2.3 > Hyperparameter Experiments with Tensorflow, PyTorch and Keras diff --git a/docs/index.html b/docs/index.html index c9e846d1..05e01112 100644 --- a/docs/index.html +++ b/docs/index.html @@ -16,7 +16,7 @@