File size: 8,010 Bytes
05c9ac2 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
import pytest
import yaml
from unittest.mock import MagicMock, patch, mock_open
from mlagents.trainers import learn
from mlagents.trainers.trainer_controller import TrainerController
from mlagents.trainers.learn import parse_command_line
from mlagents.trainers.cli_utils import DetectDefault
from mlagents_envs.exception import UnityEnvironmentException
from mlagents.trainers.stats import StatsReporter
from mlagents.trainers.environment_parameter_manager import EnvironmentParameterManager
import os.path
def basic_options(extra_args=None):
extra_args = extra_args or {}
args = ["basic_path"]
if extra_args:
args += [f"{k}={v}" for k, v in extra_args.items()]
return parse_command_line(args)
MOCK_YAML = """
behaviors:
{}
"""
MOCK_INITIALIZE_YAML = """
behaviors:
{}
checkpoint_settings:
initialize_from: notuselessrun
"""
MOCK_PARAMETER_YAML = """
behaviors:
{}
env_settings:
env_path: "./oldenvfile"
num_envs: 4
num_areas: 4
base_port: 4001
seed: 9870
checkpoint_settings:
run_id: uselessrun
initialize_from: notuselessrun
debug: false
"""
@patch("mlagents.trainers.learn.write_timing_tree")
@patch("mlagents.trainers.learn.write_run_options")
@patch("mlagents.trainers.learn.validate_existing_directories")
@patch("mlagents.trainers.learn.TrainerFactory")
@patch("mlagents.trainers.learn.SubprocessEnvManager")
@patch("mlagents.trainers.learn.create_environment_factory")
@patch("mlagents.trainers.settings.load_config")
def test_run_training(
load_config,
create_environment_factory,
subproc_env_mock,
trainer_factory_mock,
handle_dir_mock,
write_run_options_mock,
write_timing_tree_mock,
):
mock_env = MagicMock()
mock_env.external_brain_names = []
mock_env.academy_name = "TestAcademyName"
create_environment_factory.return_value = mock_env
load_config.return_value = yaml.safe_load(MOCK_INITIALIZE_YAML)
mock_param_manager = MagicMock(return_value="mock_param_manager")
mock_init = MagicMock(return_value=None)
with patch.object(EnvironmentParameterManager, "__new__", mock_param_manager):
with patch.object(TrainerController, "__init__", mock_init):
with patch.object(TrainerController, "start_learning", MagicMock()):
options = basic_options()
learn.run_training(0, options, 1)
mock_init.assert_called_once_with(
trainer_factory_mock.return_value,
os.path.join("results", "ppo"),
"ppo",
"mock_param_manager",
True,
0,
)
handle_dir_mock.assert_called_once_with(
os.path.join("results", "ppo"),
False,
False,
os.path.join("results", "notuselessrun"),
)
write_timing_tree_mock.assert_called_once_with(
os.path.join("results", "ppo", "run_logs")
)
write_run_options_mock.assert_called_once_with(
os.path.join("results", "ppo"), options
)
StatsReporter.writers.clear() # make sure there aren't any writers as added by learn.py
def test_bad_env_path():
with pytest.raises(UnityEnvironmentException):
factory = learn.create_environment_factory(
env_path="/foo/bar",
no_graphics=True,
seed=-1,
num_areas=1,
start_port=8000,
env_args=None,
log_folder="results/log_folder",
)
factory(worker_id=-1, side_channels=[])
@patch("builtins.open", new_callable=mock_open, read_data=MOCK_YAML)
def test_commandline_args(mock_file):
# No args raises
# with pytest.raises(SystemExit):
# parse_command_line([])
# Test with defaults
opt = parse_command_line(["mytrainerpath"])
assert opt.behaviors == {}
assert opt.env_settings.env_path is None
assert opt.checkpoint_settings.resume is False
assert opt.checkpoint_settings.inference is False
assert opt.checkpoint_settings.run_id == "ppo"
assert opt.checkpoint_settings.initialize_from is None
assert opt.env_settings.seed == -1
assert opt.env_settings.base_port == 5005
assert opt.env_settings.num_envs == 1
assert opt.env_settings.num_areas == 1
assert opt.engine_settings.no_graphics is False
assert opt.debug is False
assert opt.env_settings.env_args is None
full_args = [
"mytrainerpath",
"--env=./myenvfile",
"--inference",
"--run-id=myawesomerun",
"--seed=7890",
"--train",
"--base-port=4004",
"--initialize-from=testdir",
"--num-envs=2",
"--num-areas=2",
"--no-graphics",
"--debug",
]
opt = parse_command_line(full_args)
assert opt.behaviors == {}
assert opt.env_settings.env_path == "./myenvfile"
assert opt.checkpoint_settings.run_id == "myawesomerun"
assert opt.checkpoint_settings.initialize_from == "testdir"
assert opt.env_settings.seed == 7890
assert opt.env_settings.base_port == 4004
assert opt.env_settings.num_envs == 2
assert opt.env_settings.num_areas == 2
assert opt.engine_settings.no_graphics is True
assert opt.debug is True
assert opt.checkpoint_settings.inference is True
assert opt.checkpoint_settings.resume is False
# ignore init if resume is set
full_args.append("--resume")
opt = parse_command_line(full_args)
assert opt.checkpoint_settings.initialize_from is None # ignore init if resume set
assert opt.checkpoint_settings.resume is True
@patch("builtins.open", new_callable=mock_open, read_data=MOCK_PARAMETER_YAML)
def test_yaml_args(mock_file):
# Test with opts loaded from YAML
DetectDefault.non_default_args.clear()
opt = parse_command_line(["mytrainerpath"])
assert opt.behaviors == {}
assert opt.env_settings.env_path == "./oldenvfile"
assert opt.checkpoint_settings.run_id == "uselessrun"
assert opt.checkpoint_settings.initialize_from == "notuselessrun"
assert opt.env_settings.seed == 9870
assert opt.env_settings.base_port == 4001
assert opt.env_settings.num_envs == 4
assert opt.env_settings.num_areas == 4
assert opt.engine_settings.no_graphics is False
assert opt.debug is False
assert opt.env_settings.env_args is None
# Test that CLI overrides YAML
full_args = [
"mytrainerpath",
"--env=./myenvfile",
"--resume",
"--inference",
"--run-id=myawesomerun",
"--seed=7890",
"--train",
"--base-port=4004",
"--num-envs=2",
"--num-areas=2",
"--no-graphics",
"--debug",
"--results-dir=myresults",
]
opt = parse_command_line(full_args)
assert opt.behaviors == {}
assert opt.env_settings.env_path == "./myenvfile"
assert opt.checkpoint_settings.run_id == "myawesomerun"
assert opt.env_settings.seed == 7890
assert opt.env_settings.base_port == 4004
assert opt.env_settings.num_envs == 2
assert opt.env_settings.num_areas == 2
assert opt.engine_settings.no_graphics is True
assert opt.debug is True
assert opt.checkpoint_settings.inference is True
assert opt.checkpoint_settings.resume is True
assert opt.checkpoint_settings.results_dir == "myresults"
@patch("builtins.open", new_callable=mock_open, read_data=MOCK_YAML)
def test_env_args(mock_file):
full_args = [
"mytrainerpath",
"--env=./myenvfile",
"--env-args", # Everything after here will be grouped in a list
"--foo=bar",
"--blah",
"baz",
"100",
]
opt = parse_command_line(full_args)
assert opt.env_settings.env_args == ["--foo=bar", "--blah", "baz", "100"]
|