Skip to content

Commit

Permalink
Merge pull request #21 from demml/add-hw-table
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
thorrester committed Jun 12, 2024
2 parents ff888d4 + d5b7fc8 commit 0d605d4
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions docs/docs/cards/runcard.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RunCard

`RunCards` are use to store metrics and artifacts related to `DataCards` and `ModelCards`. While a RunCard can be used as a object itself, it's best when used as part of a `Project` run.
`RunCards` are used to store metrics and artifacts related to `DataCards` and `ModelCards`. While a RunCard can be used as a object itself, it's best when used as part of a `Project` run.

### Creating A Run
Runs are unique context-managed executions associated with a `Project` that record all created cards and their associated metrics, params, and artifacts to a single card called a `RunCard`.
Expand Down Expand Up @@ -79,9 +79,17 @@ with project.run() as run:
run.log_artifact_from_file("artifact", "artifact.txt")
```


You can now log into the `Opsml` server and see your recent run and associated metadata

### Logging Hardware

`Runs` can also log hardware information by simply changing 1 input argument.

- Instead of `with project.run() as run:` use `with project.run(log_hardware=True) as run:` and now hardware information will be logged. For information on what hardware information is logged, see the documentation below.

- If you want to change the hardware logging time interval, simply change the `hardware_interval` in the `run` method `with project.run(log_hardware=True, hardware_interval=10) as run:`. Note: the `hardware_interval` is in seconds and the lowest value is 10 seconds. Default is 30 seconds.


::: opsml.RunCard
options:
members:
Expand All @@ -102,3 +110,28 @@ You can now log into the `Opsml` server and see your recent run and associated m
show_source: true
heading_level: 3

::: opsml.types.metrics.HardwareMetrics
options:
show_root_heading: true
show_source: true
heading_level: 3

::: opsml.types.metrics.CPUMetrics
options:
show_root_heading: true
show_source: true
heading_level: 3

::: opsml.types.metrics.MemoryMetrics
options:
show_root_heading: true
show_source: true
heading_level: 3

::: opsml.types.metrics.NetworkRates
options:
show_root_heading: true
show_source: true
heading_level: 3


0 comments on commit 0d605d4

Please sign in to comment.