mirror of
https://github.com/Stone-Red-Code/dvc.git
synced 2026-11-10 23:10:42 +01:00
karajan1001
244637e299
fix: #7154 1. rename flags `-A/--all-commits` in the `exp pull/push` 2. add new flag "--rev" and "--num" in the `exp pull/push` 3. Unify the collection of revs in `exp push/pull` 4. add unit and func tests for `exp push/pull`
118 lines
3.5 KiB
Python
118 lines
3.5 KiB
Python
import argparse
|
|
import logging
|
|
|
|
from dvc.cli.command import CmdBase
|
|
from dvc.cli.utils import append_doc_link
|
|
from dvc.exceptions import InvalidArgumentError
|
|
from dvc.ui import ui
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class CmdExperimentsPull(CmdBase):
|
|
def raise_error_if_all_disabled(self):
|
|
if not any(
|
|
[self.args.experiment, self.args.all_commits, self.args.rev]
|
|
):
|
|
raise InvalidArgumentError(
|
|
"Either provide an `experiment` argument, or use the "
|
|
"`--rev` or `--all-commits` flag."
|
|
)
|
|
|
|
def run(self):
|
|
self.raise_error_if_all_disabled()
|
|
|
|
pulled_exps = self.repo.experiments.pull(
|
|
self.args.git_remote,
|
|
self.args.experiment,
|
|
all_commits=self.args.all_commits,
|
|
rev=self.args.rev,
|
|
num=self.args.num,
|
|
force=self.args.force,
|
|
pull_cache=self.args.pull_cache,
|
|
dvc_remote=self.args.dvc_remote,
|
|
jobs=self.args.jobs,
|
|
run_cache=self.args.run_cache,
|
|
)
|
|
|
|
if pulled_exps:
|
|
ui.write(
|
|
f"Pulled experiment '{pulled_exps}'",
|
|
f"from Git remote '{self.args.git_remote}'.",
|
|
)
|
|
else:
|
|
ui.write("No experiments to pull.")
|
|
if not self.args.pull_cache:
|
|
ui.write(
|
|
"To pull cached outputs for this experiment"
|
|
"from DVC remote storage,"
|
|
"re-run this command without '--no-cache'."
|
|
)
|
|
|
|
return 0
|
|
|
|
|
|
def add_parser(experiments_subparsers, parent_parser):
|
|
from . import add_rev_selection_flags
|
|
|
|
EXPERIMENTS_PULL_HELP = "Pull an experiment from a Git remote."
|
|
experiments_pull_parser = experiments_subparsers.add_parser(
|
|
"pull",
|
|
parents=[parent_parser],
|
|
description=append_doc_link(EXPERIMENTS_PULL_HELP, "exp/pull"),
|
|
help=EXPERIMENTS_PULL_HELP,
|
|
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
)
|
|
add_rev_selection_flags(experiments_pull_parser, "Pull", False)
|
|
experiments_pull_parser.add_argument(
|
|
"-f",
|
|
"--force",
|
|
action="store_true",
|
|
help="Replace local experiment already exists.",
|
|
)
|
|
experiments_pull_parser.add_argument(
|
|
"--no-cache",
|
|
action="store_false",
|
|
dest="pull_cache",
|
|
help=(
|
|
"Do not pull cached outputs for this experiment from DVC remote "
|
|
"storage."
|
|
),
|
|
)
|
|
experiments_pull_parser.add_argument(
|
|
"-r",
|
|
"--remote",
|
|
dest="dvc_remote",
|
|
metavar="<name>",
|
|
help="Name of the DVC remote to use when pulling cached outputs.",
|
|
)
|
|
experiments_pull_parser.add_argument(
|
|
"-j",
|
|
"--jobs",
|
|
type=int,
|
|
metavar="<number>",
|
|
help=(
|
|
"Number of jobs to run simultaneously when pulling from DVC "
|
|
"remote storage."
|
|
),
|
|
)
|
|
experiments_pull_parser.add_argument(
|
|
"--run-cache",
|
|
action="store_true",
|
|
default=False,
|
|
help="Pull run history for all stages.",
|
|
)
|
|
experiments_pull_parser.add_argument(
|
|
"git_remote",
|
|
help="Git remote name or Git URL.",
|
|
metavar="<git_remote>",
|
|
)
|
|
experiments_pull_parser.add_argument(
|
|
"experiment",
|
|
nargs="*",
|
|
default=None,
|
|
help="Experiments to pull.",
|
|
metavar="<experiment>",
|
|
)
|
|
experiments_pull_parser.set_defaults(func=CmdExperimentsPull)
|