Merge pull request #78 from UFRN-URNAI/issue-72

Resolves #72

tests/units/states/test_state_base.py

@@ -0,0 +1,25 @@
+import unittest
+from abc import ABCMeta
+
+from urnai.states.state_base import StateBase
+
+
+class TestStateBase(unittest.TestCase):
+
+    def test_abstract_methods(self):
+        StateBase.__abstractmethods__ = set()
+
+        class FakeState(StateBase):
+            def __init__(self):
+                super().__init__()
+
+        fake_state = FakeState()
+        update_return = fake_state.update("observation")
+        state = fake_state.state
+        dimension = fake_state.dimension
+        reset_return = fake_state.reset()
+        assert isinstance(StateBase, ABCMeta)
+        assert update_return is None
+        assert state is None
+        assert dimension is None
+        assert reset_return is None

urnai/states/state_base.py

@@ -0,0 +1,38 @@
+from abc import ABC, abstractmethod
+from typing import Any, List
+
+
+class StateBase(ABC):
+    """
+    Every Agent needs to own an instance of this base class 
+    in order to define its State.
+    So every time we want to create a new agent,
+    we should either use an existing State implementation or create a new one.
+    """
+
+    @abstractmethod
+    def update(self, obs) -> List[Any]:
+        """
+        This method receives as a parameter an Observation and returns a State, which 
+        is usually a list of features extracted from the Observation. The Agent uses
+        this State during training to receive a new action from its model and also to
+        make it learn, that's why this method should always return a list.
+        """
+        pass
+
+    @property
+    @abstractmethod
+    def state(self):
+        """Returns the State currently saved."""
+        pass
+
+    @property
+    @abstractmethod
+    def dimension(self):
+        """Returns the dimensions of the States returned by the update method."""
+        pass
+
+    @abstractmethod
+    def reset(self):
+        """Resets the State currently saved."""
+        pass