ums

 1# Agenten Plattform
 2#
 3# (c) 2024 Magnus Bender
 4# 	Institute of Humanities-Centered Artificial Intelligence (CHAI)
 5# 	Universitaet Hamburg
 6# 	https://www.chai.uni-hamburg.de/~bender
 7#  
 8# source code released under the terms of GNU Public License Version 3
 9# https://www.gnu.org/licenses/gpl-3.0.txt
10
11"""
12The 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).
13
14> Side note: The classes with comments may be useful when implementing the agents.
15> The classes without comments may be safe to ignore and are (only) used internally.
16
17- `ums.agent`
18	- Contains the implementation of an agent for handling requests by the implementations in `src`.
19- `ums.example`
20	- Contains a very simple examples for all types of agents.
21	- See `ums.example.example`
22- `ums.management`
23	- Contains the implementation of the management.
24	- Take a look at the web gui of the management!
25- `ums.utils`
26	- Contains various utilities.
27	- `ums.utils.const.SHARE_PATH` The path for shared files between all agents
28	- `ums.utils.const.PERSIST_PATH` The path to store persistent data of an agent
29	- `ums.utils.request.ManagementRequest` Run request to the management (only necessary in special cases, most requests done automatically by platform)
30	- `ums.utils.schema` The schema (types) used in the files storing extracted data from plain data
31	- `ums.utils.types` The types used in the communication between agent and management
32
33"""