oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Format docstrings

Browse Source
This commit is contained in:
Marek Wolan
2023-07-04 11:11:52 +01:00
parent 91273b2f99
commit 9244c160b1
39 changed files with 208 additions and 409 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
src/primaite/agents/agent.py
View File

@@ -21,8 +21,7 @@ _LOGGER = getLogger(__name__)
def get_session_path(session_timestamp: datetime) -> Path:
"""
Get the directory path the session will output to.
"""Get the directory path the session will output to.
This is set in the format of:
~/primaite/sessions/<yyyy-mm-dd>/<yyyy-mm-dd>_<hh-mm-ss>.
@@ -39,11 +38,10 @@ def get_session_path(session_timestamp: datetime) -> Path:
class AgentSessionABC(ABC):
"""
An ABC that manages training and/or evaluation of agents in PrimAITE.
"""An ABC that manages training and/or evaluation of agents in PrimAITE.
This class cannot be directly instantiated and must be inherited from
with all implemented abstract methods implemented.
This class cannot be directly instantiated and must be inherited from with all implemented abstract methods
implemented.
"""
@abstractmethod
@@ -186,8 +184,7 @@ class AgentSessionABC(ABC):
self,
**kwargs,
):
"""
Train the agent.
"""Train the agent.
:param kwargs: Any agent-specific key-word args to be passed.
"""
@@ -204,8 +201,7 @@ class AgentSessionABC(ABC):
self,
**kwargs,
):
"""
Evaluate the agent.
"""Evaluate the agent.
:param kwargs: Any agent-specific key-word args to be passed.
"""
@@ -293,11 +289,10 @@ class AgentSessionABC(ABC):
class HardCodedAgentSessionABC(AgentSessionABC):
"""
An Agent Session ABC for evaluation deterministic agents.
"""An Agent Session ABC for evaluation deterministic agents.
This class cannot be directly instantiated and must be inherited from
with all implemented abstract methods implemented.
This class cannot be directly instantiated and must be inherited from with all implemented abstract methods
implemented.
"""
def __init__(self, training_config_path, lay_down_config_path):
@@ -325,8 +320,7 @@ class HardCodedAgentSessionABC(AgentSessionABC):
self,
**kwargs,
):
"""
Train the agent.
"""Train the agent.
:param kwargs: Any agent-specific key-word args to be passed.
"""
@@ -340,8 +334,7 @@ class HardCodedAgentSessionABC(AgentSessionABC):
self,
**kwargs,
):
"""
Evaluate the agent.
"""Evaluate the agent.
:param kwargs: Any agent-specific key-word args to be passed.
"""