experiments: cleanup minor UI issues (#5147)

* exp apply: show passed exp name in CLI output instead of resolved git sha

* exp res: warn that --name will be ignored when resuming without
modifications

* exp gc: don't re-use gc parameter check message

* exp: update help strings

* exp: warn if exp dir contains untracked files after tmpdir execution

Author: pmrowla

dvc/command/experiments.py

@@ -457,10 +457,16 @@ def run(self):
         return 0
 
 
+def _raise_error_if_all_disabled(**kwargs):
+    if not any(kwargs.values()):
+        raise InvalidArgumentError(
+            "Either of `-w|--workspace`, `-a|--all-branches`, `-T|--all-tags` "
+            "or `--all-commits` needs to be set."
+        )
+
+
 class CmdExperimentsGC(CmdRepro):
     def run(self):
-        from dvc.repo.gc import _raise_error_if_all_disabled
-
         _raise_error_if_all_disabled(
             all_branches=self.args.all_branches,
             all_tags=self.args.all_tags,
@@ -600,7 +606,7 @@ def add_parser(subparsers, parent_parser):
         "experiments",
         parents=[parent_parser],
         aliases=["exp"],
-        description=append_doc_link(EXPERIMENTS_HELP, "experiments"),
+        description=append_doc_link(EXPERIMENTS_HELP, "exp"),
         formatter_class=argparse.RawDescriptionHelpFormatter,
         help=EXPERIMENTS_HELP,
     )
@@ -617,7 +623,7 @@ def add_parser(subparsers, parent_parser):
     experiments_show_parser = experiments_subparsers.add_parser(
         "show",
         parents=[parent_parser],
-        description=append_doc_link(EXPERIMENTS_SHOW_HELP, "experiments/show"),
+        description=append_doc_link(EXPERIMENTS_SHOW_HELP, "exp/show"),
         help=EXPERIMENTS_SHOW_HELP,
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )
@@ -626,20 +632,20 @@ def add_parser(subparsers, parent_parser):
         "--all-branches",
         action="store_true",
         default=False,
-        help="Show metrics for all branches.",
+        help="Show experiments derived from the tip of all Git branches.",
     )
     experiments_show_parser.add_argument(
         "-T",
         "--all-tags",
         action="store_true",
         default=False,
-        help="Show metrics for all tags.",
+        help="Show experiments derived from all Git tags.",
     )
     experiments_show_parser.add_argument(
         "--all-commits",
         action="store_true",
         default=False,
-        help="Show metrics for all commits.",
+        help="Show experiments derived from all Git commits.",
     )
     experiments_show_parser.add_argument(
         "--no-pager",
@@ -721,9 +727,7 @@ def add_parser(subparsers, parent_parser):
     experiments_apply_parser = experiments_subparsers.add_parser(
         "apply",
         parents=[parent_parser],
-        description=append_doc_link(
-            EXPERIMENTS_APPLY_HELP, "experiments/apply"
-        ),
+        description=append_doc_link(EXPERIMENTS_APPLY_HELP, "exp/apply"),
         help=EXPERIMENTS_APPLY_HELP,
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )
@@ -744,7 +748,7 @@ def add_parser(subparsers, parent_parser):
     experiments_diff_parser = experiments_subparsers.add_parser(
         "diff",
         parents=[parent_parser],
-        description=append_doc_link(EXPERIMENTS_DIFF_HELP, "experiments/diff"),
+        description=append_doc_link(EXPERIMENTS_DIFF_HELP, "exp/diff"),
         help=EXPERIMENTS_DIFF_HELP,
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )
@@ -803,7 +807,7 @@ def add_parser(subparsers, parent_parser):
     experiments_run_parser = experiments_subparsers.add_parser(
         "run",
         parents=[parent_parser],
-        description=append_doc_link(EXPERIMENTS_RUN_HELP, "experiments/run"),
+        description=append_doc_link(EXPERIMENTS_RUN_HELP, "exp/run"),
         help=EXPERIMENTS_RUN_HELP,
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )
@@ -818,9 +822,7 @@ def add_parser(subparsers, parent_parser):
         "resume",
         parents=[parent_parser],
         aliases=["res"],
-        description=append_doc_link(
-            EXPERIMENTS_RESUME_HELP, "experiments/resume"
-        ),
+        description=append_doc_link(EXPERIMENTS_RESUME_HELP, "exp/resume"),
         help=EXPERIMENTS_RESUME_HELP,
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )
@@ -848,9 +850,7 @@ def add_parser(subparsers, parent_parser):
     experiments_gc_parser = experiments_subparsers.add_parser(
         "gc",
         parents=[parent_parser],
-        description=append_doc_link(
-            EXPERIMENTS_GC_DESCRIPTION, "experiments/gc"
-        ),
+        description=append_doc_link(EXPERIMENTS_GC_DESCRIPTION, "exp/gc"),
         help=EXPERIMENTS_GC_HELP,
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )
@@ -903,9 +903,7 @@ def add_parser(subparsers, parent_parser):
     experiments_branch_parser = experiments_subparsers.add_parser(
         "branch",
         parents=[parent_parser],
-        description=append_doc_link(
-            EXPERIMENTS_BRANCH_HELP, "experiments/branch"
-        ),
+        description=append_doc_link(EXPERIMENTS_BRANCH_HELP, "exp/branch"),
         help=EXPERIMENTS_BRANCH_HELP,
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )
@@ -921,7 +919,7 @@ def add_parser(subparsers, parent_parser):
     experiments_list_parser = experiments_subparsers.add_parser(
         "list",
         parents=[parent_parser],
-        description=append_doc_link(EXPERIMENTS_LIST_HELP, "experiments/list"),
+        description=append_doc_link(EXPERIMENTS_LIST_HELP, "exp/list"),
         help=EXPERIMENTS_LIST_HELP,
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )
@@ -955,7 +953,7 @@ def add_parser(subparsers, parent_parser):
     experiments_push_parser = experiments_subparsers.add_parser(
         "push",
         parents=[parent_parser],
-        description=append_doc_link(EXPERIMENTS_PUSH_HELP, "experiments/push"),
+        description=append_doc_link(EXPERIMENTS_PUSH_HELP, "exp/push"),
         help=EXPERIMENTS_PUSH_HELP,
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )
@@ -1011,7 +1009,7 @@ def add_parser(subparsers, parent_parser):
     experiments_pull_parser = experiments_subparsers.add_parser(
         "pull",
         parents=[parent_parser],
-        description=append_doc_link(EXPERIMENTS_PULL_HELP, "experiments/pull"),
+        description=append_doc_link(EXPERIMENTS_PULL_HELP, "exp/pull"),
         help=EXPERIMENTS_PULL_HELP,
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )
@@ -1076,6 +1074,7 @@ def _add_run_common(parser):
             "Human-readable experiment name. If not specified, a name will "
             "be auto-generated."
         ),
+        metavar="<name>",
     )
     parser.add_argument(
         "--params",

dvc/repo/experiments/__init__.py

@@ -209,6 +209,12 @@ def _stash_exp(
                                 "Resuming from tip of existing branch '%s'",
                                 branch,
                             )
+                            if name:
+                                logger.warning(
+                                    "Ignoring option '--name %s' for resumed "
+                                    "experiment. Existing experiment name will"
+                                    "be preserved instead."
+                                )
 
                     # save additional repro command line arguments
                     self._pack_args(*args, **kwargs)

dvc/repo/experiments/apply.py

@@ -69,7 +69,7 @@ def apply(repo, rev, force=False, **kwargs):
 
     dvc_checkout(repo, **kwargs)
 
-    repo.scm.set_ref(EXEC_APPLY, rev)
+    repo.scm.set_ref(EXEC_APPLY, exp_rev)
     logger.info(
         "Changes for experiment '%s' have been applied to your current "
         "workspace.",

dvc/repo/experiments/executor/base.py

@@ -61,6 +61,7 @@ class BaseExecutor(ABC):
     """
 
     PACKED_ARGS_FILE = "repro.dat"
+    WARN_UNTRACKED = False
 
     def __init__(
         self,
@@ -304,6 +305,16 @@ def filter_pipeline(stages):
             ref = dvc.scm.get_ref(EXEC_BRANCH, follow=False)
             if ref:
                 exp_ref = ExpRefInfo.from_ref(ref)
+            if cls.WARN_UNTRACKED:
+                untracked = dvc.scm.untracked_files()
+                if untracked:
+                    logger.warning(
+                        "The following untracked files were present in the "
+                        "experiment directory after reproduction but will "
+                        "not be included in experiment commits:\n"
+                        "\t%s",
+                        ", ".join(untracked),
+                    )
         finally:
             if dvc:
                 dvc.scm.close()

dvc/repo/experiments/executor/local.py

@@ -25,6 +25,8 @@ def git_url(self) -> str:
 class TempDirExecutor(BaseLocalExecutor):
     """Temp directory experiment executor."""
 
+    WARN_UNTRACKED = True
+
     def __init__(
         self,
         *args,