Show changes in
dvc params between commits in the DVC repository,
or between a commit and the workspace.
Requires that Git is being used to version the project.
usage: dvc params diff [-h] [-q | -v] [--targets [<paths> [<paths> ...]]] [--all] [--deps] [--json] [--md] [--no-path] positional arguments: a_rev Old Git commit to compare (defaults to HEAD) b_rev New Git commit to compare (defaults to the current workspace)
Provides a quick way to compare parameters among experiments in the repository history. The differences shown by this command include the old and new param values, along with the param name.
Parameters are defined in the
params field of
dvc params diff compares parameters currently present in
the workspace (uncommitted changes) with the latest committed
versions (required). This includes everything in
parameters file) as well all the
params used in
dvc.yaml. Values in
dvc.lock are used for comparison. Only params that have changes are listed.
b_rev are optional Git commit hashes, tags, or branch names to
compare. A single specified revision results in comparing it against the
All params defined in
dvc.yaml are used by default, but specific ones can be
specified with the
Note that targets don't necessarily have to be defined in
dvc.yaml. For that reason, it doesn't require an existing DVC project to run in. It can work in any Git repo.
--targets <paths>- specific params files to compare. It accepts
pathsto any valid parameters file, regardless of whether
dvc.yamlis currently tracking any params in them.
When specifying arguments for
b_rev, you should use
--after this option's arguments (POSIX terminals), e.g.:
$ dvc params diff --targets m1.json m2.yaml -- HEAD v1
--all- list all parameters, including those without changes.
--deps- include only parameters that are stage dependencies.
--json- prints the command's output in easily parsable JSON format, instead of a human-readable table.
--md- prints the command's output in the Markdown table format.
--help- prints the usage/help message, and exit.
--quiet- do not write anything to standard output. Exit with 0 if no problems arise, otherwise 1.
--verbose- displays detailed tracing information.
Let's create a simple YAML parameters file named
params.yaml (default params
file name, see
dvc params to learn more):
lr: 0.0041 train: epochs: 70 layers: 9 process: thresh: 0.98 bow: 15000
Define a pipeline stage with parameter dependencies:
$ dvc stage add -n train \ -d train.py -d users.csv -o model.pkl \ -p lr,train \ python train.py
Let's now print parameter values that we are tracking in this project:
$ dvc params diff Path Param HEAD workspace params.yaml lr — 0.0041 params.yaml process.bow — 15000 params.yaml process.thresh — 0.98 params.yaml train.epochs — 70 params.yaml train.layers — 9
The command above shows the difference in parameters between the workspace and
the last committed version (
HEAD) of the params file
params.yaml. Since it
did not exist before, all
HEAD values are
In a project with parameters file history (params present in various Git
commits), you will see both
workspace values. However, the
parameters won't be shown if there are no changes:
$ dvc params diff Path Param HEAD workspace params.yaml lr 0.0041 0.0043 params.yaml train.layers 9 7 params.yaml train.epochs 70 110
--all option to see all the parameters including not changed ones:
$ dvc params diff --all Path Param HEAD workspace params.yaml lr 0.0041 0.0043 params.yaml process.bow 15000 15000 params.yaml process.thresh 0.98 0.98 params.yaml train.layers 9 7 params.yaml train.epochs 70 110
To compare parameters with a specific commit, a tag or any revision can be specified, as an additional command line parameter:
$ dvc params diff e12b167 Path Param HEAD e12b167 params.yaml lr 0.0038 0.0043 params.yaml train.epochs 70 110
Note that the
train.layers parameter disappeared because its value was not
changed between the current version in the workspace and the given one
To see the difference between two specific commits, both need to be specified:
$ dvc params diff e12b167 HEAD^ Path Param e12b167 HEAD^ params.yaml lr 0.0038 0.0041 params.yaml train.layers 10 9 params.yaml train.epochs 50 70