Skip to content

Commit

Permalink
readme: add rst code blocks (#50)
Browse files Browse the repository at this point in the history
  • Loading branch information
pared authored Feb 17, 2021
1 parent da02aed commit 361dd22
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ user to log the model metrics as the training progresses.

The interface consists of three main methods:

1. `dvclive.init(path)` - initializes dvclive logger. The metrics will be saved under `path`.
1. :code:`dvclive.init(path)` - initializes dvclive logger. The metrics will be saved under :code:`path`.

2. `dvclive.log(metric, value, step)` - logs the metric value. The value and step will be appended to `path/{metric}.tsv` file. The step value is optional.
2. :code:`dvclive.log(metric, value, step)` - logs the metric value. The value and step will be appended to :code:`path/{metric}.tsv` file. The step value is optional.

3. `dvclive.next_step()` - signals `dvclive` that current step has ended. Executed automatically if `metric` is logged again.
3. :code:`dvclive.next_step()` - signals :code:`dvclive` that current step has ended. Executed automatically if :code:`metric` is logged again.

0 comments on commit 361dd22

Please sign in to comment.