|
| 1 | +# Copyright (c) 2019-2020, RTE (https://www.rte-france.com) |
| 2 | +# See AUTHORS.txt |
| 3 | +# This Source Code Form is subject to the terms of the Mozilla Public License, version 2.0. |
| 4 | +# If a copy of the Mozilla Public License, version 2.0 was not distributed with this file, |
| 5 | +# you can obtain one at http://mozilla.org/MPL/2.0/. |
| 6 | +# SPDX-License-Identifier: MPL-2.0 |
| 7 | +# This file is part of Grid2Op, Grid2Op a testbed platform to model sequential decision making in power systems. |
| 8 | + |
| 9 | +""" |
| 10 | +This file should be used to assess the performance of grid2op in "runner" mode: the loading time are not studied, |
| 11 | +neither are the import times. |
| 12 | +
|
| 13 | +Data are loaded only once, when the environment is "done" the programm stops. |
| 14 | +
|
| 15 | +This corresponds to the situation: you have a trained agent, you want to assess its performance using the runner |
| 16 | +""" |
| 17 | + |
| 18 | +import numpy as np |
| 19 | +import os |
| 20 | + |
| 21 | +from grid2op import make |
| 22 | +from grid2op.Parameters import Parameters |
| 23 | +from grid2op.Rules import AlwaysLegal |
| 24 | +from grid2op.Backend import PandaPowerBackend |
| 25 | +from grid2op.Agent import DoNothingAgent |
| 26 | +import cProfile |
| 27 | + |
| 28 | +from utils_benchmark import run_env, str2bool |
| 29 | + |
| 30 | +try: |
| 31 | + from lightsim2grid import LightSimBackend |
| 32 | + light_sim_avail = True |
| 33 | +except ImportError: |
| 34 | + light_sim_avail = False |
| 35 | + |
| 36 | +ENV_NAME = "rte_case5_example" |
| 37 | +ENV_NAME = "rte_case14_realistic" |
| 38 | +ENV_NAME = "l2rpn_case14_sandbox" |
| 39 | +MAX_TS = 1000 |
| 40 | + |
| 41 | + |
| 42 | +def main(max_ts, name, use_lightsim=False, test_env=True): |
| 43 | + param = Parameters() |
| 44 | + if use_lightsim: |
| 45 | + if light_sim_avail: |
| 46 | + backend = LightSimBackend() |
| 47 | + else: |
| 48 | + raise RuntimeError("LightSimBackend not available") |
| 49 | + else: |
| 50 | + backend = PandaPowerBackend() |
| 51 | + |
| 52 | + param.init_from_dict({"NO_OVERFLOW_DISCONNECTION": True}) |
| 53 | + |
| 54 | + env_klu = make(name, backend=backend, param=param, gamerules_class=AlwaysLegal, test=test_env) |
| 55 | + agent = DoNothingAgent(action_space=env_klu.action_space) |
| 56 | + |
| 57 | + cp = cProfile.Profile() |
| 58 | + cp.enable() |
| 59 | + nb_ts_klu, time_klu, aor_klu, gen_p_klu, gen_q_klu, time_step = run_env(env_klu, max_ts, agent) |
| 60 | + cp.disable() |
| 61 | + print(f'Time for {nb_ts_klu} steps: {time_step} => {time_step / nb_ts_klu} s/step or {nb_ts_klu / time_step:.3e} step / s') |
| 62 | + nm_f, ext = os.path.splitext(__file__) |
| 63 | + nm_out = "{}_{}_{}.prof".format(nm_f, "lightsim" if use_ls else "pp", name) |
| 64 | + cp.dump_stats(nm_out) |
| 65 | + print("You can view profiling results with:\n\tsnakeviz {}".format(nm_out)) |
| 66 | + |
| 67 | + |
| 68 | +if __name__ == "__main__": |
| 69 | + import argparse |
| 70 | + parser = argparse.ArgumentParser(description='Benchmark pyKLU and Pandapower Backend for an agent that takes every ' |
| 71 | + 'topological action possible') |
| 72 | + parser.add_argument('--name', default=ENV_NAME, type=str, |
| 73 | + help='Environment name to be used for the benchmark.') |
| 74 | + parser.add_argument('--number', type=int, default=MAX_TS, |
| 75 | + help='Maximum number of time steps for which the benchamark will be run.') |
| 76 | + parser.add_argument("--use_ls", type=str2bool, nargs='?', |
| 77 | + const=True, default=False, |
| 78 | + help="Use the LightSim2Grid Backend.") |
| 79 | + parser.add_argument("--no_test", type=str2bool, nargs='?', |
| 80 | + const=True, default=False, |
| 81 | + help="Do not use a test environment for the profiling (default to False: meaning you use a test env)") |
| 82 | + |
| 83 | + args = parser.parse_args() |
| 84 | + |
| 85 | + max_ts = int(args.number) |
| 86 | + name = str(args.name) |
| 87 | + use_ls = args.use_ls |
| 88 | + test_env = not args.no_test |
| 89 | + main(max_ts, name, use_lightsim=use_ls, test_env=test_env) |
0 commit comments