From 04014f911f4c35148819ecb50bebb42ad9b21464 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Redzy=C5=84ski?= Date: Mon, 22 Feb 2021 17:41:37 +0100 Subject: [PATCH] live: initial docs draft --- content/docs/dvclive/index.md | 18 ++++++++++++++++++ content/docs/dvclive/usage.md | 0 2 files changed, 18 insertions(+) create mode 100644 content/docs/dvclive/index.md create mode 100644 content/docs/dvclive/usage.md diff --git a/content/docs/dvclive/index.md b/content/docs/dvclive/index.md new file mode 100644 index 0000000000..da6b6a632b --- /dev/null +++ b/content/docs/dvclive/index.md @@ -0,0 +1,18 @@ +# dvclive + +[dvclive](https://cml.dev) is an open-source python library for monitoring +metrics in machine learning projects. Use it to log metrics during training. + +dvclive is integrated seamlesly with dvc and logs produced by it can be fed to +`dvc plots` command. Even though, one does not need dvc to visualize dvclive +logs, as they are saved into easily readable tsv format. + +We have created dvclive with two principles in mind: + +- **no dependencies** While you can install optional integrations for various + frameworks, basic dvclive installation does not need anything besides standard + python libs. +- **integration with DVC** DVC is able to recognize when its being used in + tandem with dvclive and is able to provide useful features - like producing + training summary during training. When used in DVC project user does not have + to call `dvclive.init` method. diff --git a/content/docs/dvclive/usage.md b/content/docs/dvclive/usage.md new file mode 100644 index 0000000000..e69de29bb2