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

Jump to bottom

track dvcyaml file #710

Merged
merged 21 commits into from
Sep 21, 2023
Merged

track dvcyaml file #710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
f6a0a29
live: Set new defaults `report=None` and `save_dvc_exp=True`.
daavoo Aug 17, 2023
aa3610a
frameworks: Drop model_file.
daavoo Aug 22, 2023
2e538ce
update examples
daavoo Aug 22, 2023
0d21bb6
Merge branch 'main' into 484-30-release
daavoo Aug 30, 2023
bb34d87
fix merge conflicts
dberenbaum Sep 6, 2023
00ac887
Write to root dvc.yaml (#687)
dberenbaum Sep 7, 2023
5dcc43b
report: Drop "auto" logic.
daavoo Sep 7, 2023
7d2528e
studio: Extract `post_to_studio` and decoulple from `make_report` (#705)
daavoo Sep 7, 2023
a02d160
refactor(tests): Split `test_main` into separate files.
daavoo Sep 7, 2023
6ccc959
fix matplotlib warning
daavoo Sep 7, 2023
a539c8e
Merge branch 'main' into 484-30-release
dberenbaum Sep 11, 2023
093ce86
drop dvc.yaml prefix from studio plots
dberenbaum Sep 12, 2023
86bd3d5
refactor
dberenbaum Sep 12, 2023
085621c
drop .dvc files
dberenbaum Sep 12, 2023
69c1262
track dvcyaml file
dberenbaum Sep 14, 2023
f6001f4
Studio dvcyaml (#709)
dberenbaum Sep 14, 2023
ee9ceb0
Merge branch '484-30-release' into track-dvcyaml
dberenbaum Sep 14, 2023
627feeb
drop unneeded relpath call
dberenbaum Sep 15, 2023
56f9512
Merge branch 'track-dvcyaml' of github.com:iterative/dvclive into tra…
dberenbaum Sep 15, 2023
c4d8872
merge 3.0
dberenbaum Sep 20, 2023
4b4b62f
drop extra make_report call
dberenbaum Sep 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/dvclive/live.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,6 +559,10 @@ def end(self):
catch_and_warn(DvcException, logger)(ensure_dir_is_tracked)(
self.dir, self._dvc_repo
)
if self._dvcyaml:
catch_and_warn(DvcException, logger)(self._dvc_repo.scm.add)(
Copy link
Contributor

Choose a reason for hiding this comment

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

This is missing some test

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do you mean the warnings? Not sure what scenario would actually trigger an exception here 🤔 .

Copy link
Contributor

Choose a reason for hiding this comment

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

I meant the scm.add, it seems that we only test the include_untracked change

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch. Added it to test_untracked_dvclive_files_inside_dvc_exp_run_are_added.

self.dvc_file
)

self.make_report()

Expand Down Expand Up @@ -589,6 +593,8 @@ def __exit__(self, exc_type, exc_val, exc_tb):
@catch_and_warn(DvcException, logger, mark_dvclive_only_ended)
def save_dvc_exp(self):
if self._save_dvc_exp:
if self._dvcyaml:
self._include_untracked.append(self.dvc_file)
self._experiment_rev = self._dvc_repo.experiments.save(
name=self._exp_name,
include_untracked=self._include_untracked,
Expand Down
22 changes: 15 additions & 7 deletions tests/test_dvc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def test_exp_save_on_end(tmp_dir, save, mocked_dvc_repo):
assert live._exp_name is not None
mocked_dvc_repo.experiments.save.assert_called_with(
name=live._exp_name,
include_untracked=[live.dir],
include_untracked=[live.dir, str(tmp_dir / "dvc.yaml")],
force=True,
message=None,
)
Expand Down Expand Up @@ -67,6 +67,7 @@ def test_exp_save_run_on_dvc_repro(tmp_dir, mocker):
dvc_repo.scm.get_ref.return_value = None
dvc_repo.scm.no_commits = False
dvc_repo.config = {}
dvc_repo.root_dir = tmp_dir
mocker.patch("dvclive.live.get_dvc_repo", return_value=dvc_repo)
live = Live()
assert live._save_dvc_exp
Expand All @@ -75,7 +76,10 @@ def test_exp_save_run_on_dvc_repro(tmp_dir, mocker):
live.end()

dvc_repo.experiments.save.assert_called_with(
name=live._exp_name, include_untracked=[live.dir], force=True, message=None
name=live._exp_name,
include_untracked=[live.dir, str(tmp_dir / "dvc.yaml")],
force=True,
message=None,
)


Expand All @@ -87,14 +91,18 @@ def test_exp_save_with_dvc_files(tmp_dir, mocker):
dvc_repo.scm.get_rev.return_value = "current_rev"
dvc_repo.scm.get_ref.return_value = None
dvc_repo.scm.no_commits = False
dvc_repo.root_dir = tmp_dir
dvc_repo.config = {}

mocker.patch("dvclive.live.get_dvc_repo", return_value=dvc_repo)
live = Live()
live.end()

dvc_repo.experiments.save.assert_called_with(
name=live._exp_name, include_untracked=[live.dir], force=True, message=None
name=live._exp_name,
include_untracked=[live.dir, str(tmp_dir / "dvc.yaml")],
force=True,
message=None,
)


Expand Down Expand Up @@ -126,7 +134,7 @@ def test_untracked_dvclive_files_inside_dvc_exp_run_are_added(
with Live() as live:
live.log_metric("foo", 1)
live.next_step()
live._dvc_repo.scm.add.assert_called_with(["dvclive/metrics.json", plot_file])
live._dvc_repo.scm.add.assert_any_call(["dvclive/metrics.json", plot_file])


def test_dvc_outs_are_not_added(tmp_dir, mocked_dvc_repo, monkeypatch):
Expand All @@ -144,7 +152,7 @@ def test_dvc_outs_are_not_added(tmp_dir, mocked_dvc_repo, monkeypatch):
live.log_metric("foo", 1)
live.next_step()

live._dvc_repo.scm.add.assert_called_with(["dvclive/metrics.json"])
live._dvc_repo.scm.add.assert_any_call(["dvclive/metrics.json"])


def test_errors_on_git_add_are_catched(tmp_dir, mocked_dvc_repo, monkeypatch):
Expand All @@ -153,7 +161,7 @@ def test_errors_on_git_add_are_catched(tmp_dir, mocked_dvc_repo, monkeypatch):
mocked_dvc_repo.scm.untracked_files.return_value = ["dvclive/metrics.json"]
mocked_dvc_repo.scm.add.side_effect = DvcException("foo")

with Live() as live:
with Live(dvcyaml=False) as live:
live.summary["foo"] = 1


Expand All @@ -162,7 +170,7 @@ def test_exp_save_message(tmp_dir, mocked_dvc_repo):
live.end()
mocked_dvc_repo.experiments.save.assert_called_with(
name=live._exp_name,
include_untracked=[live.dir],
include_untracked=[live.dir, str(tmp_dir / "dvc.yaml")],
force=True,
message="Custom message",
)
Expand Down
2 changes: 1 addition & 1 deletion tests/test_log_artifact.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def test_log_artifact_with_save_dvc_exp(tmp_dir, mocker, mocked_dvc_repo):
live.log_artifact("data")
mocked_dvc_repo.experiments.save.assert_called_with(
name=live._exp_name,
include_untracked=[live.dir, "data", ".gitignore"],
include_untracked=[live.dir, "data", ".gitignore", str(tmp_dir / "dvc.yaml")],
force=True,
message=None,
)
Expand Down