def test_run_script_correct(capsys, script_filepath, config_filepath): # noqa: F811
run_script(script_filepath, config_filepath)
captured = capsys.readouterr()
out = captured.out.split("\r")
out = list(map(lambda x: x.strip(), out))
out = list(filter(None, out))
assert "Run\n1\n2\n{}\n{}".format(config_filepath.as_posix(), script_filepath.as_posix()) in out[-1]
def test_example(example_baseline_config, example_scripts_training,
example_path):
import sys
sys.path.insert(0, example_path.as_posix())
run_script(example_scripts_training, example_baseline_config)
run_script(example_scripts_training,
example_baseline_config,
manual_config_load=True)
def test_run_script_script_file_run_not_callable(dirname, config_filepath): # noqa: F811
script_fp = dirname / "script_run_not_callable.py"
s = """
run = 0
"""
with script_fp.open("w") as h:
h.write(s)
with pytest.raises(RuntimeError, match="should be a callable function"):
run_script(script_fp, config_filepath)
def test_run_script_with_local_rank(capsys, dirname, config_filepath): # noqa: F811
script_fp = dirname / "script.py"
s = """
def run(config, local_rank=0, **kwargs):
assert local_rank == 1
"""
with script_fp.open("w") as h:
h.write(s)
run_script(script_fp, config_filepath, local_rank=1)
def test_run_logging_script(capsys, logging_script_filepath,
config_filepath): # noqa: F811
run_script(logging_script_filepath, config_filepath)
captured = capsys.readouterr()
out = captured.err.split('\n')
out = list(map(lambda x: x.strip(), out))
out = list(filter(None, out))
assert "|script|INFO| Start run script" in out[0]
assert "|script|INFO| 1" in out[1]
assert "|script|INFO| 2" in out[2]
def test_run_script_raise_exeption(dirname, config_filepath): # noqa: F811
script_fp = dirname / "bad_script.py"
s = """
def run(config, **kwargs):
raise RuntimeError("STOP")
"""
with script_fp.open("w") as h:
h.write(s)
with pytest.raises(RuntimeError, match=r"STOP"):
run_script(script_fp, config_filepath)
def test_run_script_script_file_run_wrong_signature(dirname): # noqa: F811
script_fp = dirname / "script_wrong_signature.py"
s = """
def run():
pass
"""
with script_fp.open("w") as h:
h.write(s)
with pytest.raises(RuntimeError, match="Run method signature should be"):
run_script(script_fp, "")
def test_run_script_script_file_no_run(dirname, config_filepath): # noqa: F811
script_fp = dirname / "script_no_run.py"
s = """
import numpy as np
a = 123
b = np.array([1, 2, 3])
"""
with script_fp.open("w") as h:
h.write(s)
with pytest.raises(RuntimeError, match="should contain a method run"):
run_script(script_fp, config_filepath)
def command(script_filepath: str, config_filepath: str) -> None:
"""Method to run experiment (defined by a script file)
Args:
script_filepath: input script filepath
config_filepath: input configuration filepath
"""
# remove path to py_config_runner.py_config_runner module from sys.path
# as it can interfere with user's modules: py_config_runner.utils (seen as utils) <--> utils.py (user's module)
this_folder_path = Path(__file__).parent.as_posix()
import sys
if this_folder_path in sys.path:
sys.path.remove(this_folder_path)
from py_config_runner.runner import run_script
run_script(script_filepath, config_filepath)
def test_run_script_lazy_loading(capsys, dirname, config_filepath): # noqa: F811
script_fp = dirname / "lazy_loading_script.py"
s = """
from pathlib import Path
def run(config, **kwargs):
assert getattr(config, 'a', None) == 1
assert getattr(config, 'b', None) == 2
assert getattr(config, 'config_filepath', None) == Path("{}")
assert getattr(config, 'script_filepath', None) == Path("{}")
""".format(
config_filepath, script_fp
)
with script_fp.open("w") as h:
h.write(s)
run_script(script_fp, config_filepath)
def command(script_filepath, config_filepath, manual_config_load, local_rank):
"""Method to run experiment (defined by a script file)
Args:
script_filepath (str): input script filepath
config_filepath (str): input configuration filepath
manual_config_load (bool): if True configuration file can be manually loaded using
`py_config_runner.runner.setup_config` method.
local_rank (int): local process rank for distributed computations.
See https://pytorch.org/docs/stable/distributed.html#launch-utility
"""
# remove path to py_config_runner.py_config_runner module from sys.path
# as it can interfere with user's modules: py_config_runner.utils (seen as utils) <--> utils.py (user's module)
this_folder_path = Path(__file__).parent.as_posix()
import sys
if this_folder_path in sys.path:
sys.path.remove(this_folder_path)
from py_config_runner.runner import run_script
run_script(script_filepath, config_filepath, manual_config_load=manual_config_load, local_rank=local_rank)
def test_run_script_with_schema(dirname, config_filepath): # noqa: F811
script_fp = dirname / "script_with_schema.py"
s = """
from py_config_runner import Schema
class MyConfigSchema(Schema):
# Define required parameters for a training config
# Type hints are from typing
a: int
data: int
def run(config, **kwargs):
MyConfigSchema.validate(config)
"""
with script_fp.open("w") as h:
h.write(s)
run_script(script_fp, config_filepath)