|
3 | 3 | <head> |
4 | 4 | <meta charset="utf-8" /> |
5 | 5 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
6 | | - <title>csle_agents.agents.base.base_agent — csle-agents 0.5.0 documentation</title> |
| 6 | + <title>csle_agents.agents.base.base_agent — csle-agents 0.8.0 documentation</title> |
7 | 7 | <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" /> |
8 | 8 | <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" /> |
9 | 9 | <!--[if lt IE 9]> |
|
13 | 13 | <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> |
14 | 14 | <script src="../../../../_static/jquery.js"></script> |
15 | 15 | <script src="../../../../_static/underscore.js"></script> |
| 16 | + <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script> |
16 | 17 | <script src="../../../../_static/doctools.js"></script> |
| 18 | + <script src="../../../../_static/sphinx_highlight.js"></script> |
17 | 19 | <script src="../../../../_static/js/theme.js"></script> |
18 | 20 | <link rel="index" title="Index" href="../../../../genindex.html" /> |
19 | 21 | <link rel="search" title="Search" href="../../../../search.html" /> |
|
54 | 56 | <div class="rst-content"> |
55 | 57 | <div role="navigation" aria-label="Page navigation"> |
56 | 58 | <ul class="wy-breadcrumbs"> |
57 | | - <li><a href="../../../../index.html" class="icon icon-home"></a> »</li> |
58 | | - <li><a href="../../../index.html">Module code</a> »</li> |
59 | | - <li>csle_agents.agents.base.base_agent</li> |
| 59 | + <li><a href="../../../../index.html" class="icon icon-home"></a></li> |
| 60 | + <li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li> |
| 61 | + <li class="breadcrumb-item active">csle_agents.agents.base.base_agent</li> |
60 | 62 | <li class="wy-breadcrumbs-aside"> |
61 | 63 | </li> |
62 | 64 | </ul> |
@@ -84,27 +86,30 @@ <h1>Source code for csle_agents.agents.base.base_agent</h1><div class="highlight |
84 | 86 | <span class="sd"> """</span> |
85 | 87 |
|
86 | 88 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">simulation_env_config</span><span class="p">:</span> <span class="n">SimulationEnvConfig</span><span class="p">,</span> |
87 | | - <span class="n">emulation_env_config</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">EmulationEnvConfig</span><span class="p">,</span> <span class="kc">None</span><span class="p">],</span> <span class="n">experiment_config</span><span class="p">:</span> <span class="n">ExperimentConfig</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| 89 | + <span class="n">emulation_env_config</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">EmulationEnvConfig</span><span class="p">,</span> <span class="kc">None</span><span class="p">],</span> <span class="n">experiment_config</span><span class="p">:</span> <span class="n">ExperimentConfig</span><span class="p">,</span> |
| 90 | + <span class="n">create_log_dir</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
88 | 91 | <span class="w"> </span><span class="sd">"""</span> |
89 | 92 | <span class="sd"> Initializes the agent</span> |
90 | 93 |
|
91 | 94 | <span class="sd"> :param simulation_env_config: the configuration of the simulation environment</span> |
92 | 95 | <span class="sd"> :param emulation_env_config: the configuration of the emulation environment</span> |
93 | 96 | <span class="sd"> :param experiment_config: the experiment configuration</span> |
| 97 | +<span class="sd"> :param create_log_dir: Boolean flag whether to create a log directory or not</span> |
94 | 98 | <span class="sd"> """</span> |
95 | 99 | <span class="n">GeneralUtil</span><span class="o">.</span><span class="n">register_envs</span><span class="p">()</span> |
96 | 100 | <span class="bp">self</span><span class="o">.</span><span class="n">simulation_env_config</span> <span class="o">=</span> <span class="n">simulation_env_config</span> |
97 | 101 | <span class="bp">self</span><span class="o">.</span><span class="n">emulation_env_config</span> <span class="o">=</span> <span class="n">emulation_env_config</span> |
98 | 102 | <span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span> <span class="o">=</span> <span class="n">experiment_config</span> |
99 | 103 | <span class="n">ts</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> |
100 | | - <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span><span class="o">.</span><span class="n">output_dir</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"/"</span><span class="p">:</span> |
101 | | - <span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span><span class="o">.</span><span class="n">output_dir</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span><span class="o">.</span><span class="n">output_dir</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> |
102 | | - <span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span><span class="o">.</span><span class="n">output_dir</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span><span class="o">.</span><span class="n">output_dir</span> <span class="o">+</span> <span class="sa">f</span><span class="s2">"_</span><span class="si">{</span><span class="n">ts</span><span class="si">}</span><span class="s2">/"</span> |
103 | | - <span class="k">try</span><span class="p">:</span> |
104 | | - <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span><span class="o">.</span><span class="n">output_dir</span><span class="p">):</span> |
105 | | - <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span><span class="o">.</span><span class="n">output_dir</span><span class="p">)</span> |
106 | | - <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
107 | | - <span class="n">Logger</span><span class="o">.</span><span class="fm">__call__</span><span class="p">()</span><span class="o">.</span><span class="n">get_logger</span><span class="p">()</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">"There was an error creating log dirs: </span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span><span class="si">}</span><span class="s2">, </span><span class="si">{</span><span class="nb">repr</span><span class="p">(</span><span class="n">e</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span> |
| 104 | + <span class="k">if</span> <span class="n">create_log_dir</span><span class="p">:</span> |
| 105 | + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span><span class="o">.</span><span class="n">output_dir</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"/"</span><span class="p">:</span> |
| 106 | + <span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span><span class="o">.</span><span class="n">output_dir</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span><span class="o">.</span><span class="n">output_dir</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> |
| 107 | + <span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span><span class="o">.</span><span class="n">output_dir</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span><span class="o">.</span><span class="n">output_dir</span> <span class="o">+</span> <span class="sa">f</span><span class="s2">"_</span><span class="si">{</span><span class="n">ts</span><span class="si">}</span><span class="s2">/"</span> |
| 108 | + <span class="k">try</span><span class="p">:</span> |
| 109 | + <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span><span class="o">.</span><span class="n">output_dir</span><span class="p">):</span> |
| 110 | + <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">experiment_config</span><span class="o">.</span><span class="n">output_dir</span><span class="p">)</span> |
| 111 | + <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| 112 | + <span class="n">Logger</span><span class="o">.</span><span class="fm">__call__</span><span class="p">()</span><span class="o">.</span><span class="n">get_logger</span><span class="p">()</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">"There was an error creating log dirs: </span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span><span class="si">}</span><span class="s2">, </span><span class="si">{</span><span class="nb">repr</span><span class="p">(</span><span class="n">e</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span> |
108 | 113 |
|
109 | 114 | <div class="viewcode-block" id="BaseAgent.train"><a class="viewcode-back" href="../../../../csle_agents.agents.base.html#csle_agents.agents.base.base_agent.BaseAgent.train">[docs]</a> <span class="nd">@abstractmethod</span> |
110 | 115 | <span class="k">def</span> <span class="nf">train</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">ExperimentExecution</span><span class="p">:</span> |
|
0 commit comments