def _add_run_common(parser): """Add common args for 'exp run' and 'exp resume'.""" # inherit arguments from `dvc repro` add_repro_arguments(parser) parser.add_argument( "--params", action="append", default=[], help="Use the specified param values when reproducing pipelines.", metavar="[<filename>:]<params_list>", ) parser.add_argument( "--queue", action="store_true", default=False, help="Stage this experiment in the run queue for future execution.", ) parser.add_argument( "--run-all", action="store_true", default=False, help="Execute all experiments in the run queue.", ) parser.add_argument( "-j", "--jobs", type=int, help="Run the specified number of experiments at a time in parallel.", metavar="<number>", )
def _add_run_common(parser): """Add common args for 'exp run' and 'exp resume'.""" # inherit arguments from `dvc repro` add_repro_arguments(parser) parser.add_argument( "-n", "--name", default=None, help=( "Human-readable experiment name. If not specified, a name will " "be auto-generated." ), metavar="<name>", ) parser.add_argument( "-S", "--set-param", action="append", default=[], help="Use the specified param value when reproducing pipelines.", metavar="[<filename>:]<param_name>=<param_value>", ) parser.add_argument( "--queue", action="store_true", default=False, help="Stage this experiment in the run queue for future execution.", ) parser.add_argument( "--run-all", action="store_true", default=False, help="Execute all experiments in the run queue. Implies --temp.", ) parser.add_argument( "-j", "--jobs", type=int, default=1, help="Run the specified number of experiments at a time in parallel.", metavar="<number>", ) parser.add_argument( "--temp", action="store_true", dest="tmp_dir", help=( "Run this experiment in a separate temporary directory instead of " "your workspace." ), )
def add_parser(subparsers, parent_parser): EXPERIMENTS_HELP = "Commands to display and compare experiments." experiments_parser = subparsers.add_parser( "experiments", parents=[parent_parser], aliases=["exp"], description=append_doc_link(EXPERIMENTS_HELP, "experiments"), formatter_class=argparse.RawDescriptionHelpFormatter, ) experiments_subparsers = experiments_parser.add_subparsers( dest="cmd", help="Use `dvc experiments CMD --help` to display " "command-specific help.", ) fix_subparsers(experiments_subparsers) EXPERIMENTS_SHOW_HELP = "Print experiments." experiments_show_parser = experiments_subparsers.add_parser( "show", parents=[parent_parser], description=append_doc_link(EXPERIMENTS_SHOW_HELP, "experiments/show"), help=EXPERIMENTS_SHOW_HELP, formatter_class=argparse.RawDescriptionHelpFormatter, ) experiments_show_parser.add_argument( "-a", "--all-branches", action="store_true", default=False, help="Show metrics for all branches.", ) experiments_show_parser.add_argument( "-T", "--all-tags", action="store_true", default=False, help="Show metrics for all tags.", ) experiments_show_parser.add_argument( "--all-commits", action="store_true", default=False, help="Show metrics for all commits.", ) experiments_show_parser.add_argument( "--no-pager", action="store_true", default=False, help="Do not pipe output into a pager.", ) experiments_show_parser.add_argument( "--include-metrics", action="append", default=[], help="Include the specified metrics in output table.", metavar="<metrics_list>", ) experiments_show_parser.add_argument( "--exclude-metrics", action="append", default=[], help="Exclude the specified metrics from output table.", metavar="<metrics_list>", ) experiments_show_parser.add_argument( "--include-params", action="append", default=[], help="Include the specified params in output table.", metavar="<params_list>", ) experiments_show_parser.add_argument( "--exclude-params", action="append", default=[], help="Exclude the specified params from output table.", metavar="<params_list>", ) experiments_show_parser.add_argument( "--sort-by", help="Sort related experiments by the specified metric or param.", metavar="<metric/param>", ) experiments_show_parser.add_argument( "--sort-order", help="Sort order to use with --sort-by.", choices=("asc", "desc"), default="asc", ) experiments_show_parser.add_argument( "--no-timestamp", action="store_true", default=False, help="Do not show experiment timestamps.", ) experiments_show_parser.add_argument( "--sha", action="store_true", default=False, help="Always show git commit SHAs instead of branch/tag names.", ) experiments_show_parser.add_argument( "--show-json", action="store_true", default=False, help="Print output in JSON format instead of a human-readable table.", ) experiments_show_parser.set_defaults(func=CmdExperimentsShow) EXPERIMENTS_CHECKOUT_HELP = "Checkout experiments." experiments_checkout_parser = experiments_subparsers.add_parser( "checkout", parents=[parent_parser], description=append_doc_link(EXPERIMENTS_CHECKOUT_HELP, "experiments/checkout"), help=EXPERIMENTS_CHECKOUT_HELP, formatter_class=argparse.RawDescriptionHelpFormatter, ) experiments_checkout_parser.add_argument( "experiment", help="Checkout this experiment.", ) experiments_checkout_parser.set_defaults(func=CmdExperimentsCheckout) EXPERIMENTS_DIFF_HELP = ( "Show changes between experiments in the DVC repository.") experiments_diff_parser = experiments_subparsers.add_parser( "diff", parents=[parent_parser], description=append_doc_link(EXPERIMENTS_DIFF_HELP, "experiments/diff"), help=EXPERIMENTS_DIFF_HELP, formatter_class=argparse.RawDescriptionHelpFormatter, ) experiments_diff_parser.add_argument( "a_rev", nargs="?", help="Old experiment to compare (defaults to HEAD)") experiments_diff_parser.add_argument( "b_rev", nargs="?", help="New experiment to compare (defaults to the current workspace)", ) experiments_diff_parser.add_argument( "--all", action="store_true", default=False, help="Show unchanged metrics/params as well.", ) experiments_diff_parser.add_argument( "--show-json", action="store_true", default=False, help="Show output in JSON format.", ) experiments_diff_parser.add_argument( "--show-md", action="store_true", default=False, help="Show tabulated output in the Markdown format (GFM).", ) experiments_diff_parser.add_argument( "--old", action="store_true", default=False, help="Show old metric/param value.", ) experiments_diff_parser.add_argument( "--no-path", action="store_true", default=False, help="Don't show metric/param path.", ) experiments_diff_parser.add_argument( "--precision", type=int, help=("Round metrics/params to `n` digits precision after the decimal " f"point. Rounds to {DEFAULT_PRECISION} digits by default."), metavar="<n>", ) experiments_diff_parser.set_defaults(func=CmdExperimentsDiff) EXPERIMENTS_RUN_HELP = ( "Reproduce complete or partial experiment pipelines.") experiments_run_parser = experiments_subparsers.add_parser( "run", parents=[parent_parser], description=append_doc_link(EXPERIMENTS_RUN_HELP, "experiments/run"), help=EXPERIMENTS_RUN_HELP, formatter_class=argparse.RawDescriptionHelpFormatter, ) # inherit arguments from `dvc repro` add_repro_arguments(experiments_run_parser) experiments_run_parser.add_argument( "--params", action="append", default=[], help="Use the specified param values when reproducing pipelines.", metavar="[<filename>:]<params_list>", ) experiments_run_parser.add_argument( "--queue", action="store_true", default=False, help="Stage this experiment in the run queue for future execution.", ) experiments_run_parser.add_argument( "--run-all", action="store_true", default=False, help="Execute all experiments in the run queue.", ) experiments_run_parser.add_argument( "-j", "--jobs", type=int, help="Run the specified number of experiments at a time in parallel.", metavar="<number>", ) experiments_run_parser.add_argument( "--checkpoint", action="store_true", default=False, help="Reproduce pipelines as a checkpoint experiment.", ) experiments_run_parser.add_argument( "--continue", nargs=1, default=None, dest="checkpoint_continue", help=("Continue from the specified checkpoint experiment" "(implies --checkpoint)."), ) experiments_run_parser.set_defaults(func=CmdExperimentsRun)