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.

Sign up for GitHub

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

Update README #528

Merged
merged 5 commits into from
Apr 14, 2023
Merged

Update README #528

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
02bcd5c
Update readme
daavoo Apr 14, 2023
16aed3c
Updates
daavoo Apr 14, 2023
87d42e9
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 14, 2023
4b75601
Fix internal link
daavoo Apr 14, 2023
17cae74
Add mdformat hook
daavoo Apr 14, 2023
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
8 changes: 6 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
* [ ] ❗ I have followed the [Contributing to DVCLive](https://github.com/iterative/dvclive/blob/master/CONTRIBUTING.md) guide.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think those could be excluded btw. As far as I remember formatting them breaks the rendering in some subtle way. We are excluding them in all the websites.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hukkin/mdformat#359 😅

- \[ \] ❗ I have followed the
[Contributing to DVCLive](https://github.com/iterative/dvclive/blob/master/CONTRIBUTING.md)
guide.

* [ ] 📖 If this PR requires [documentation](https://dvc.org/doc) updates, I have created a separate PR (or issue, at least) in [dvc.org](https://github.com/iterative/dvc.org) and linked it here.
- \[ \] 📖 If this PR requires [documentation](https://dvc.org/doc) updates, I
have created a separate PR (or issue, at least) in
[dvc.org](https://github.com/iterative/dvc.org) and linked it here.

Thank you for the contribution - we'll try to review it as soon as possible. 🙏
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,8 @@ repos:
rev: 'v0.0.261'
hooks:
- id: ruff
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.16
hooks:
- id: mdformat
args: ["--wrap=80"]
65 changes: 37 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,17 @@
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

DVCLive is a Python library for logging machine learning metrics and
other metadata in simple file formats, which is fully compatible with
DVC.
DVCLive is a Python library for logging machine learning metrics and other
metadata in simple file formats, which is fully compatible with DVC.

# [Documentation](https://dvc.org/doc/dvclive)

- [Get Started](https://dvc.org/doc/start/experiments)
- [How it Works](https://dvc.org/doc/dvclive/how-it-works)
- [API Reference](https://dvc.org/doc/dvclive/live)
- [Integrations](https://dvc.org/doc/dvclive/ml-frameworks)
- [Get Started](https://dvc.org/doc/start/experiments)
- [How it Works](https://dvc.org/doc/dvclive/how-it-works)
- [API Reference](https://dvc.org/doc/dvclive/live)
- [Integrations](https://dvc.org/doc/dvclive/ml-frameworks)

---
______________________________________________________________________

# Quickstart

Expand Down Expand Up @@ -60,8 +59,8 @@ with Live(save_dvc_exp=True) as live:
live.next_step()
```

See [Integrations](https://dvc.org/doc/dvclive/ml-frameworks) for examples
using DVCLive alongside different ML Frameworks.
See [Integrations](https://dvc.org/doc/dvclive/ml-frameworks) for examples using
DVCLive alongside different ML Frameworks.

## Running

Expand All @@ -79,12 +78,14 @@ DVCLive outputs can be rendered in different ways:

### DVC CLI

You can use [dvc exp show](https://dvc.org/doc/command-reference/exp/show) and [dvc plots](https://dvc.org/doc/command-reference/plots) to compare and visualize metrics,
parameters and plots across experiments:
You can use [dvc exp show](https://dvc.org/doc/command-reference/exp/show) and
[dvc plots](https://dvc.org/doc/command-reference/plots) to compare and
visualize metrics, parameters and plots across experiments:

```console
$ dvc exp show
```

```
─────────────────────────────────────────────────────────────────────────────────────────────────────────────
Experiment Created train.accuracy train.loss val.accuracy val.loss step epochs
Expand All @@ -105,7 +106,13 @@ $ dvc plots diff $(dvc exp list --names-only) --open

### DVC Extension for VS Code

Inside the [DVC Extension for VS Code](https://marketplace.visualstudio.com/items?itemName=Iterative.dvc), you can compare and visualize results using the [Experiments](https://github.com/iterative/vscode-dvc/blob/main/extension/resources/walkthrough/experiments-table.md) and [Plots](https://github.com/iterative/vscode-dvc/blob/main/extension/resources/walkthrough/plots.md) views:
Inside the
[DVC Extension for VS Code](https://marketplace.visualstudio.com/items?itemName=Iterative.dvc),
you can compare and visualize results using the
[Experiments](https://github.com/iterative/vscode-dvc/blob/main/extension/resources/walkthrough/experiments-table.md)
and
[Plots](https://github.com/iterative/vscode-dvc/blob/main/extension/resources/walkthrough/plots.md)
views:

![VSCode Experiments](./docs/vscode_experiments.png)

Expand All @@ -115,41 +122,43 @@ While experiments are running, live updates will be displayed in both views.

### DVC Studio

If you push the results to [DVC Studio](https://dvc.org/doc/studio), you can compare experiments against the entire repo history:
If you push the results to [DVC Studio](https://dvc.org/doc/studio), you can
compare experiments against the entire repo history:

![Studio Compare](./docs/studio_compare.png)

You can enable [Studio Live Experiments](https://dvc.org/doc/studio/user-guide/projects-and-experiments/live-metrics-and-plots) to see live updates while
experiments are running.
You can enable
[Studio Live Experiments](https://dvc.org/doc/studio/user-guide/projects-and-experiments/live-metrics-and-plots)
to see live updates while experiments are running.

---
______________________________________________________________________

# Comparison to related technologies

**DVCLive** is an *ML Logger*, similar to:

- [MLFlow](https://mlflow.org/)
- [Weights & Biases](https://wandb.ai/site)
- [Neptune](https://neptune.ai/)
- [MLFlow](https://mlflow.org/)
- [Weights & Biases](https://wandb.ai/site)
- [Neptune](https://neptune.ai/)

The main difference with those *ML Loggers* is that **DVCLive** does not
**require** any additional services or servers to run.

Logged metrics, parameters, and plots are stored as plain text files that can be
shcheklein marked this conversation as resolved.
Show resolved Hide resolved
versioned by tools like Git or tracked as pointers to files in DVC storage.

You can then use different [options](#comparing) to visualize the metrics, parameters, and
plots across experiments.
You can then use different [options](#comparing) to visualize the metrics,
parameters, and plots across experiments.

------------------------------------------------------------------------
______________________________________________________________________

# Contributing

Contributions are very welcome. To learn more, see the [Contributor
Guide](CONTRIBUTING.rst).
Contributions are very welcome. To learn more, see the
[Contributor Guide](CONTRIBUTING.rst).

# License

Distributed under the terms of the [Apache 2.0
license](https://opensource.org/licenses/Apache-2.0), *dvclive* is free
and open source software.
Distributed under the terms of the
[Apache 2.0 license](https://opensource.org/licenses/Apache-2.0), *dvclive* is
free and open source software.