Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Follow up to example docs for dvclive api url #190

Merged
merged 6 commits into from
Mar 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,4 @@ can be imported regularly, for example:
from dvclive import Live
```

Will import the main class of the API:
[`Live()`](/doc/dvclive/api-reference/live).
Will import the main class of the API: [`Live()`](/doc/dvclive/live).
10 changes: 4 additions & 6 deletions packages/example/content/docs/dvclive/dvclive-with-dvc.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,12 +90,10 @@ $ tree
└── train.py
```

The [metrics summary](/doc/dvclive/api-reference/live/log#description)
`training_metrics.json` can be used by `dvc metrics` and visualized with
`dvc exp show`/`dvc exp diff`.
The [metrics summary](/doc/dvclive/live/log#description) `training_metrics.json`
can be used by `dvc metrics` and visualized with `dvc exp show`/`dvc exp diff`.

In addition, the
[metrics history](/doc/dvclive/api-reference/live/log#step-updates) generated
In addition, the [metrics history](/doc/dvclive/live/log#step-updates) generated
under `training_metrics/scalars` can be visualized with `dvc plots`.

### Iterative Studio
Expand Down Expand Up @@ -128,7 +126,7 @@ When used alongside DVC, DVCLive can create _checkpoint_ signal files used by
DVC <abbr>experiments<abbr>.

This will save all the outputs (metrics, plots, models, etc.) associated to each
[`step`](/doc/dvclive/api-reference/live/get_step).
[`step`](/doc/dvclive/live/get_step).

You can learn more about how to use them in the
[Checkpoints User Guide](/docs/user-guide/experiment-management/checkpoints).
Expand Down
2 changes: 1 addition & 1 deletion packages/example/content/docs/dvclive/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ from dvclive import Live
live = Live()
```

See [`Live()`](/doc/dvclive/api-reference/live) for details.
See [`Live()`](/doc/dvclive/live) for details.

### Log data

Expand Down
2 changes: 1 addition & 1 deletion packages/example/content/docs/dvclive/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ fully compatible with DVC. You can
Use DVCLive alonside your favorite ML Framework
</card>

<card href="/doc/dvclive/api-reference" heading="API Reference">
<card href="/doc/dvclive" heading="API Reference">
See details of all DVCLive's functions
</card>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ other metadata.

- `dir` - Location of the directory to store
[outputs](/doc/dvclive/get-started#outputs).
- `summary_path` - Location of the
[summary](/doc/dvclive/api-reference/live/#parameters).
- `summary_path` - Location of the [summary](/doc/dvclive/live/#parameters).
- `html_path` - Location of the
[html report](/doc/dvclive/dvclive-with-dvc#html-report).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ the <abbr>pipeline</abbr>, `DVC` will
## Example

Given the [Usage](#usage) code snippet above, the
[metrics history](/doc/dvclive/api-reference/live/log#step-updates) generated
for `metric_1` would be:
[metrics history](/doc/dvclive/live/log#step-updates) generated for `metric_1`
would be:

```dvc
$ cat dvclive/metric_1.tsv
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ more info.
be saved at the end of each `step`.

- `**kwargs` - Any additional arguments will be passed to
[`Live`](/docs/dvclive/api-reference/live).
[`Live`](/docs/dvclive/live).

## Examples

Expand All @@ -63,7 +63,7 @@ runner.train(
callbacks=[DvcLiveCallback(model_file="model.pth")])
```

- Using `**kwargs` to customize [`Live`](/docs/dvclive/api-reference/live).
- Using `**kwargs` to customize [`Live`](/docs/dvclive/live).

```python
from dvclive.catalyst import DvcLiveCallback
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ more info.
be saved at the end of each `step`.

- `**kwargs` - Any additional arguments will be passed to
[`Live`](/docs/dvclive/api-reference/live).
[`Live`](/docs/dvclive/live).

## Examples

Expand All @@ -57,7 +57,7 @@ learn.fit_one_cycle(
cbs=[DvcLiveCallback(model_file="model.pth")])
```

- Using `**kwargs` to customize [`Live`](/docs/dvclive/api-reference/live).
- Using `**kwargs` to customize [`Live`](/docs/dvclive/live).

```python
from dvclive.fastai import DvcLiveCallback
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ more info.
be saved at the end of each `step`.

- `**kwargs` - Any additional arguments will be passed to
[`Live`](/docs/dvclive/api-reference/live).
[`Live`](/docs/dvclive/live).

## Examples

Expand All @@ -69,7 +69,7 @@ trainer.add_callback(
trainer.train()
```

- Using `**kwargs` to customize [`Live`](/docs/dvclive/api-reference/live).
- Using `**kwargs` to customize [`Live`](/docs/dvclive/live).

```python
from dvclive.huggingface import DvcLiveCallback
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ more info.
is saved (`model.save(model_file)`)

- `**kwargs` - Any additional arguments will be passed to
[`Live`](/docs/dvclive/api-reference/live).
[`Live`](/docs/dvclive/live).

## Examples

Expand All @@ -65,7 +65,7 @@ model.fit(
save_weights_only=True)])
```

- Using `**kwargs` to customize [`Live`](/docs/dvclive/api-reference/live).
- Using `**kwargs` to customize [`Live`](/docs/dvclive/live).

```python
from dvclive.keras import DvcLiveCallback
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ more info.
be saved at the end of each `step`.

- `**kwargs` - Any additional arguments will be passed to
[`Live`](/docs/dvclive/api-reference/live).
[`Live`](/docs/dvclive/live).

## Examples

Expand All @@ -58,7 +58,7 @@ lightgbm.train(
callbacks=[DvcLiveCallback(model_file="lgbm_model.txt")])
```

- Using `**kwargs` to customize [`Live`](/docs/dvclive/api-reference/live).
- Using `**kwargs` to customize [`Live`](/docs/dvclive/live).

```python
lightgbm.train(
Expand Down
4 changes: 2 additions & 2 deletions packages/example/content/docs/dvclive/ml-frameworks/mmcv.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ more info.
be saved at the end of each `step`.

- `**kwargs` - Any additional arguments will be passed to
[`Live`](/docs/dvclive/api-reference/live).
[`Live`](/docs/dvclive/live).

## Examples

Expand All @@ -54,7 +54,7 @@ log_config = dict(
)
```

- Using `**kwargs` to customize [`Live`](/docs/dvclive/api-reference/live).
- Using `**kwargs` to customize [`Live`](/docs/dvclive/live).

```python
log_config = dict(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,15 @@ more info.

- `prefix` - (`None` by default) - string that adds to each metric name.

- `experiment` - (`None` by default) -
[`Live`](/docs/dvclive/api-reference/live) object to be used instead of
initializing a new one.
- `experiment` - (`None` by default) - [`Live`](/docs/dvclive/live) object to be
used instead of initializing a new one.

- `**kwargs` - Any additional arguments will be passed to
[`Live`](/docs/dvclive/api-reference/live).
[`Live`](/docs/dvclive/live).

## Examples

- Using `**kwargs` to customize [`Live`](/docs/dvclive/api-reference/live).
- Using `**kwargs` to customize [`Live`](/docs/dvclive/live).

```python
from dvclive.lightning import DvcLiveLogger
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ more info.
be saved at the end of each `step`.

- `**kwargs` - Any additional arguments will be passed to
[`Live`](/docs/dvclive/api-reference/live).
[`Live`](/docs/dvclive/live).

## Examples

- Using `**kwargs` to customize [`Live`](/docs/dvclive/api-reference/live).
- Using `**kwargs` to customize [`Live`](/docs/dvclive/live).

```python
xgboost.train(
Expand Down