Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Mikko Kotila committed Apr 15, 2022
1 parent fb6a0f8 commit d206143
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 11 deletions.
16 changes: 9 additions & 7 deletions docs/Energy_Draw.md
Original file line number Diff line number Diff line change
Expand Up @@ -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()`.

2 changes: 1 addition & 1 deletion docs/_coverpage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![logo](_media/talos_logo_bg.png)

## v1.2
## v1.2.3

> Hyperparameter Experiments with Tensorflow, PyTorch and Keras
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<div id="app"></div>
<script>
window.$docsify = {
name: 'Talos 1.2',
name: 'Talos 1.2.3',
repo: 'https://github.com/autonomio/talos',
coverpage: true,
loadSidebar: true,
Expand Down
4 changes: 2 additions & 2 deletions talos/utils/power_draw_append.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ def power_draw_append(history, power_draw):

'''For appending the data from PowerDrawCallback to the history object
and allowing the data to be captured in the experiment log in Talos.
history | object | tf.keras model history object
power_draw | object | PowerDrawCallback object
'''

import numpy as np
Expand Down

0 comments on commit d206143

Please sign in to comment.