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

dvclive: Updates for "DVCLive only" experiments #4162

Merged
merged 22 commits into from
Dec 15, 2022
Merged

dvclive: Updates for "DVCLive only" experiments #4162

Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
78f926c
dvclive: Add `save_dvc_exp` to API reference.
daavoo Dec 5, 2022
b64fc46
Add `dvclive.env`
daavoo Dec 14, 2022
3dbae19
Updates for DVCLive only
daavoo Dec 14, 2022
f7f82a7
Add notes about `dvc.yaml`.
daavoo Dec 14, 2022
c44a53b
Add `Live.end` to the sidebar
daavoo Dec 14, 2022
d6044df
Passed -> Passing
daavoo Dec 14, 2022
c60802a
docs -> doc
daavoo Dec 14, 2022
1ca3432
Merge branch 'main' of github.com:iterative/dvc.org into dvclive-expe…
rogermparent Dec 14, 2022
e0fbe5d
Add missing `dvc.yaml`
daavoo Dec 14, 2022
9da99c5
Update content/docs/dvclive/get-started.md
daavoo Dec 14, 2022
d6b086b
Update content/docs/dvclive/get-started.md
daavoo Dec 14, 2022
16c7a46
Renames. script -> code. VSCode -> VS Code
daavoo Dec 14, 2022
6e1e56a
Update content/docs/dvclive/api-reference/live/end.md
daavoo Dec 14, 2022
1670fd9
Restyled by prettier (#4179)
restyled-io[bot] Dec 14, 2022
3a8fec4
update end
daavoo Dec 14, 2022
18bc70c
Add framework example in end
daavoo Dec 14, 2022
219a245
Copy from end to next_step
daavoo Dec 14, 2022
484ffe3
Update how it works table
daavoo Dec 14, 2022
65fb4b4
Consolidate explanation to how-it-works
Dec 15, 2022
97c87f0
Update content/docs/dvclive/how-it-works.md
daavoo Dec 15, 2022
f70a509
Minor updates
daavoo Dec 15, 2022
6cdd4a2
Restyled by prettier (#4181)
restyled-io[bot] Dec 15, 2022
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
4 changes: 4 additions & 0 deletions content/docs/dvclive/api-reference/live/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ class Live:
dir: str = "dvclive",
resume: bool = False,
report: Optional[str] = "auto",
save_dvc_exp: bool = False,
):
```

Expand Down Expand Up @@ -71,6 +72,9 @@ You can use `Live()` as a context manager. When exiting the context manager,

If `report` is `None`, `Live.make_report()` won't generate anything.

- `save_dvc_exp` - If `True`, DVCLive will create a DVC <abbr>experiment</abbr>
as part of `live.end()`.

## Methods

- `Live.log_image()`
Expand Down