UMS-Agenten/Agenten-Plattform
3
0
Fork 0
Code Issues Actions Packages Releases Activity

More Optim.

Browse Source
This commit is contained in:
Magnus Bender
2024-10-30 16:10:53 +01:00
parent 53bc4ac219
commit 01db00b3b4
13 changed files with 1454 additions and 886 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
web/public/docs/ums.html
View File

@ -46,20 +46,77 @@
<h1 class="modulename">
ums </h1>
<div class="docstring"><p>The package <code><a href="">ums</a></code> contains the Agenten-Plattform, the implementations of the agents shall be created in the package <code>src</code>, see <a href="https://git.chai.uni-hamburg.de/UMS-Agenten/Agent-Template">Agent-Template</a>.</p>
<blockquote>
<p>Side note: The classes with comments may be useful when implementing the agents.
The classes without comments may be safe to ignore and are (only) used internally.</p>
</blockquote>
<ul>
<li><code><a href="ums/agent.html">ums.agent</a></code>
<ul>
<li>Contains the implementation of an agent for handling requests by the implementations in <code>src</code>.</li>
</ul></li>
<li><code><a href="ums/example.html">ums.example</a></code>
<ul>
<li>Contains a very simple examples for all types of agents.</li>
<li>See <code><a href="ums/example/example.html">ums.example.example</a></code></li>
</ul></li>
<li><code><a href="ums/management.html">ums.management</a></code>
<ul>
<li>Contains the implementation of the management.</li>
<li>Take a look at the web gui of the management!</li>
</ul></li>
<li><code><a href="ums/utils.html">ums.utils</a></code>
<ul>
<li>Contains various utilities.</li>
<li><code><a href="ums/utils/const.html#SHARE_PATH">ums.utils.const.SHARE_PATH</a></code> The path for shared files between all agents</li>
<li><code><a href="ums/utils/const.html#PERSIST_PATH">ums.utils.const.PERSIST_PATH</a></code> The path to store persistent data of an agent</li>
<li><code><a href="ums/utils/request.html#ManagementRequest">ums.utils.request.ManagementRequest</a></code> Run request to the management (only necessary in special cases, most requests done automatically by platform)</li>
<li><code><a href="ums/utils/schema.html">ums.utils.schema</a></code> The schema (types) used in the files storing extracted data from plain data</li>
<li><code><a href="ums/utils/types.html">ums.utils.types</a></code> The types used in the communication between agent and management</li>
</ul></li>
</ul>
</div>
<input id="mod-ums-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<label class="view-source-button" for="mod-ums-view-source"><span>View Source</span></label>
<div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos">1</span></a><span class="c1"># Agenten Plattform</span>
</span><span id="L-2"><a href="#L-2"><span class="linenos">2</span></a><span class="c1">#</span>
</span><span id="L-3"><a href="#L-3"><span class="linenos">3</span></a><span class="c1"># (c) 2024 Magnus Bender</span>
</span><span id="L-4"><a href="#L-4"><span class="linenos">4</span></a><span class="c1"># Institute of Humanities-Centered Artificial Intelligence (CHAI)</span>
</span><span id="L-5"><a href="#L-5"><span class="linenos">5</span></a><span class="c1"># Universitaet Hamburg</span>
</span><span id="L-6"><a href="#L-6"><span class="linenos">6</span></a><span class="c1"># https://www.chai.uni-hamburg.de/~bender</span>
</span><span id="L-7"><a href="#L-7"><span class="linenos">7</span></a><span class="c1"># </span>
</span><span id="L-8"><a href="#L-8"><span class="linenos">8</span></a><span class="c1"># source code released under the terms of GNU Public License Version 3</span>
</span><span id="L-9"><a href="#L-9"><span class="linenos">9</span></a><span class="c1"># https://www.gnu.org/licenses/gpl-3.0.txt</span>
<div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos"> 1</span></a><span class="c1"># Agenten Plattform</span>
</span><span id="L-2"><a href="#L-2"><span class="linenos"> 2</span></a><span class="c1">#</span>
</span><span id="L-3"><a href="#L-3"><span class="linenos"> 3</span></a><span class="c1"># (c) 2024 Magnus Bender</span>
</span><span id="L-4"><a href="#L-4"><span class="linenos"> 4</span></a><span class="c1"># Institute of Humanities-Centered Artificial Intelligence (CHAI)</span>
</span><span id="L-5"><a href="#L-5"><span class="linenos"> 5</span></a><span class="c1"># Universitaet Hamburg</span>
</span><span id="L-6"><a href="#L-6"><span class="linenos"> 6</span></a><span class="c1"># https://www.chai.uni-hamburg.de/~bender</span>
</span><span id="L-7"><a href="#L-7"><span class="linenos"> 7</span></a><span class="c1"># </span>
</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a><span class="c1"># source code released under the terms of GNU Public License Version 3</span>
</span><span id="L-9"><a href="#L-9"><span class="linenos"> 9</span></a><span class="c1"># https://www.gnu.org/licenses/gpl-3.0.txt</span>
</span><span id="L-10"><a href="#L-10"><span class="linenos">10</span></a>
</span><span id="L-11"><a href="#L-11"><span class="linenos">11</span></a><span class="sd">&quot;&quot;&quot;</span>
</span><span id="L-12"><a href="#L-12"><span class="linenos">12</span></a><span class="sd">The package `ums` contains the Agenten-Plattform, the implementations of the agents shall be created in the package `src`, see [Agent-Template](https://git.chai.uni-hamburg.de/UMS-Agenten/Agent-Template).</span>
</span><span id="L-13"><a href="#L-13"><span class="linenos">13</span></a>
</span><span id="L-14"><a href="#L-14"><span class="linenos">14</span></a><span class="sd">&gt; Side note: The classes with comments may be useful when implementing the agents.</span>
</span><span id="L-15"><a href="#L-15"><span class="linenos">15</span></a><span class="sd">&gt; The classes without comments may be safe to ignore and are (only) used internally.</span>
</span><span id="L-16"><a href="#L-16"><span class="linenos">16</span></a>
</span><span id="L-17"><a href="#L-17"><span class="linenos">17</span></a><span class="sd">- `ums.agent`</span>
</span><span id="L-18"><a href="#L-18"><span class="linenos">18</span></a><span class="sd"> - Contains the implementation of an agent for handling requests by the implementations in `src`.</span>
</span><span id="L-19"><a href="#L-19"><span class="linenos">19</span></a><span class="sd">- `ums.example`</span>
</span><span id="L-20"><a href="#L-20"><span class="linenos">20</span></a><span class="sd"> - Contains a very simple examples for all types of agents.</span>
</span><span id="L-21"><a href="#L-21"><span class="linenos">21</span></a><span class="sd"> - See `ums.example.example`</span>
</span><span id="L-22"><a href="#L-22"><span class="linenos">22</span></a><span class="sd">- `ums.management`</span>
</span><span id="L-23"><a href="#L-23"><span class="linenos">23</span></a><span class="sd"> - Contains the implementation of the management.</span>
</span><span id="L-24"><a href="#L-24"><span class="linenos">24</span></a><span class="sd"> - Take a look at the web gui of the management!</span>
</span><span id="L-25"><a href="#L-25"><span class="linenos">25</span></a><span class="sd">- `ums.utils`</span>
</span><span id="L-26"><a href="#L-26"><span class="linenos">26</span></a><span class="sd"> - Contains various utilities.</span>
</span><span id="L-27"><a href="#L-27"><span class="linenos">27</span></a><span class="sd"> - `ums.utils.const.SHARE_PATH` The path for shared files between all agents</span>
</span><span id="L-28"><a href="#L-28"><span class="linenos">28</span></a><span class="sd"> - `ums.utils.const.PERSIST_PATH` The path to store persistent data of an agent</span>
</span><span id="L-29"><a href="#L-29"><span class="linenos">29</span></a><span class="sd"> - `ums.utils.request.ManagementRequest` Run request to the management (only necessary in special cases, most requests done automatically by platform)</span>
</span><span id="L-30"><a href="#L-30"><span class="linenos">30</span></a><span class="sd"> - `ums.utils.schema` The schema (types) used in the files storing extracted data from plain data</span>
</span><span id="L-31"><a href="#L-31"><span class="linenos">31</span></a><span class="sd"> - `ums.utils.types` The types used in the communication between agent and management</span>
</span><span id="L-32"><a href="#L-32"><span class="linenos">32</span></a>
</span><span id="L-33"><a href="#L-33"><span class="linenos">33</span></a><span class="sd">&quot;&quot;&quot;</span>
</span></pre></div>