mirror of
https://github.com/wassname/ray.git
synced 2026-06-28 20:24:03 +08:00
Sven
60d4d5e1aa
* Remove all __future__ imports from RLlib. * Remove (object) again from tf_run_builder.py::TFRunBuilder. * Fix 2xLINT warnings. * Fix broken appo_policy import (must be appo_tf_policy) * Remove future imports from all other ray files (not just RLlib). * Remove future imports from all other ray files (not just RLlib). * Remove future import blocks that contain `unicode_literals` as well. Revert appo_tf_policy.py to appo_policy.py (belongs to another PR). * Add two empty lines before Schedule class. * Put back __future__ imports into determine_tests_to_run.py. Fails otherwise on a py2/print related error.
197 lines
7.3 KiB
Python
197 lines
7.3 KiB
Python
import argparse
|
|
import json
|
|
import os
|
|
|
|
# For compatibility under py2 to consider unicode as str
|
|
from six import string_types
|
|
|
|
from ray.tune import TuneError
|
|
from ray.tune.trial import Trial
|
|
from ray.tune.resources import json_to_resources
|
|
from ray.tune.logger import _SafeFallbackEncoder
|
|
|
|
|
|
def make_parser(parser_creator=None, **kwargs):
|
|
"""Returns a base argument parser for the ray.tune tool.
|
|
|
|
Args:
|
|
parser_creator: A constructor for the parser class.
|
|
kwargs: Non-positional args to be passed into the
|
|
parser class constructor.
|
|
"""
|
|
|
|
if parser_creator:
|
|
parser = parser_creator(**kwargs)
|
|
else:
|
|
parser = argparse.ArgumentParser(**kwargs)
|
|
|
|
# Note: keep this in sync with rllib/train.py
|
|
parser.add_argument(
|
|
"--run",
|
|
default=None,
|
|
type=str,
|
|
help="The algorithm or model to train. This may refer to the name "
|
|
"of a built-on algorithm (e.g. RLLib's DQN or PPO), or a "
|
|
"user-defined trainable function or class registered in the "
|
|
"tune registry.")
|
|
parser.add_argument(
|
|
"--stop",
|
|
default="{}",
|
|
type=json.loads,
|
|
help="The stopping criteria, specified in JSON. The keys may be any "
|
|
"field returned by 'train()' e.g. "
|
|
"'{\"time_total_s\": 600, \"training_iteration\": 100000}' to stop "
|
|
"after 600 seconds or 100k iterations, whichever is reached first.")
|
|
parser.add_argument(
|
|
"--config",
|
|
default="{}",
|
|
type=json.loads,
|
|
help="Algorithm-specific configuration (e.g. env, hyperparams), "
|
|
"specified in JSON.")
|
|
parser.add_argument(
|
|
"--resources-per-trial",
|
|
default=None,
|
|
type=json_to_resources,
|
|
help="Override the machine resources to allocate per trial, e.g. "
|
|
"'{\"cpu\": 64, \"gpu\": 8}'. Note that GPUs will not be assigned "
|
|
"unless you specify them here. For RLlib, you probably want to "
|
|
"leave this alone and use RLlib configs to control parallelism.")
|
|
parser.add_argument(
|
|
"--num-samples",
|
|
default=1,
|
|
type=int,
|
|
help="Number of times to repeat each trial.")
|
|
parser.add_argument(
|
|
"--checkpoint-freq",
|
|
default=0,
|
|
type=int,
|
|
help="How many training iterations between checkpoints. "
|
|
"A value of 0 (default) disables checkpointing.")
|
|
parser.add_argument(
|
|
"--checkpoint-at-end",
|
|
action="store_true",
|
|
help="Whether to checkpoint at the end of the experiment. "
|
|
"Default is False.")
|
|
parser.add_argument(
|
|
"--no-sync-on-checkpoint",
|
|
action="store_true",
|
|
help="Disable sync-down of trial checkpoint, which is enabled by "
|
|
"default to guarantee recoverability. If set, checkpoint syncing from "
|
|
"worker to driver is asynchronous. Set this only if synchronous "
|
|
"checkpointing is too slow and trial restoration failures can be "
|
|
"tolerated")
|
|
parser.add_argument(
|
|
"--keep-checkpoints-num",
|
|
default=None,
|
|
type=int,
|
|
help="Number of best checkpoints to keep. Others get "
|
|
"deleted. Default (None) keeps all checkpoints.")
|
|
parser.add_argument(
|
|
"--checkpoint-score-attr",
|
|
default="training_iteration",
|
|
type=str,
|
|
help="Specifies by which attribute to rank the best checkpoint. "
|
|
"Default is increasing order. If attribute starts with min- it "
|
|
"will rank attribute in decreasing order. Example: "
|
|
"min-validation_loss")
|
|
parser.add_argument(
|
|
"--export-formats",
|
|
default=None,
|
|
help="List of formats that exported at the end of the experiment. "
|
|
"Default is None. For RLlib, 'checkpoint' and 'model' are "
|
|
"supported for TensorFlow policy graphs.")
|
|
parser.add_argument(
|
|
"--max-failures",
|
|
default=3,
|
|
type=int,
|
|
help="Try to recover a trial from its last checkpoint at least this "
|
|
"many times. Only applies if checkpointing is enabled.")
|
|
parser.add_argument(
|
|
"--scheduler",
|
|
default="FIFO",
|
|
type=str,
|
|
help="FIFO (default), MedianStopping, AsyncHyperBand, "
|
|
"HyperBand, or HyperOpt.")
|
|
parser.add_argument(
|
|
"--scheduler-config",
|
|
default="{}",
|
|
type=json.loads,
|
|
help="Config options to pass to the scheduler.")
|
|
|
|
# Note: this currently only makes sense when running a single trial
|
|
parser.add_argument(
|
|
"--restore",
|
|
default=None,
|
|
type=str,
|
|
help="If specified, restore from this checkpoint.")
|
|
|
|
return parser
|
|
|
|
|
|
def to_argv(config):
|
|
"""Converts configuration to a command line argument format."""
|
|
argv = []
|
|
for k, v in config.items():
|
|
if "-" in k:
|
|
raise ValueError("Use '_' instead of '-' in `{}`".format(k))
|
|
if v is None:
|
|
continue
|
|
if not isinstance(v, bool) or v: # for argparse flags
|
|
argv.append("--{}".format(k.replace("_", "-")))
|
|
if isinstance(v, string_types):
|
|
argv.append(v)
|
|
elif isinstance(v, bool):
|
|
pass
|
|
else:
|
|
argv.append(json.dumps(v, cls=_SafeFallbackEncoder))
|
|
return argv
|
|
|
|
|
|
def create_trial_from_spec(spec, output_path, parser, **trial_kwargs):
|
|
"""Creates a Trial object from parsing the spec.
|
|
|
|
Arguments:
|
|
spec (dict): A resolved experiment specification. Arguments should
|
|
The args here should correspond to the command line flags
|
|
in ray.tune.config_parser.
|
|
output_path (str); A specific output path within the local_dir.
|
|
Typically the name of the experiment.
|
|
parser (ArgumentParser): An argument parser object from
|
|
make_parser.
|
|
trial_kwargs: Extra keyword arguments used in instantiating the Trial.
|
|
|
|
Returns:
|
|
A trial object with corresponding parameters to the specification.
|
|
"""
|
|
try:
|
|
args, _ = parser.parse_known_args(to_argv(spec))
|
|
except SystemExit:
|
|
raise TuneError("Error parsing args, see above message", spec)
|
|
if "resources_per_trial" in spec:
|
|
trial_kwargs["resources"] = json_to_resources(
|
|
spec["resources_per_trial"])
|
|
return Trial(
|
|
# Submitting trial via server in py2.7 creates Unicode, which does not
|
|
# convert to string in a straightforward manner.
|
|
trainable_name=spec["run"],
|
|
# json.load leads to str -> unicode in py2.7
|
|
config=spec.get("config", {}),
|
|
local_dir=os.path.join(spec["local_dir"], output_path),
|
|
# json.load leads to str -> unicode in py2.7
|
|
stopping_criterion=spec.get("stop", {}),
|
|
remote_checkpoint_dir=spec.get("remote_checkpoint_dir"),
|
|
checkpoint_freq=args.checkpoint_freq,
|
|
checkpoint_at_end=args.checkpoint_at_end,
|
|
sync_on_checkpoint=not args.no_sync_on_checkpoint,
|
|
keep_checkpoints_num=args.keep_checkpoints_num,
|
|
checkpoint_score_attr=args.checkpoint_score_attr,
|
|
export_formats=spec.get("export_formats", []),
|
|
# str(None) doesn't create None
|
|
restore_path=spec.get("restore"),
|
|
trial_name_creator=spec.get("trial_name_creator"),
|
|
loggers=spec.get("loggers"),
|
|
# str(None) doesn't create None
|
|
sync_to_driver_fn=spec.get("sync_to_driver"),
|
|
max_failures=args.max_failures,
|
|
**trial_kwargs)
|