valanga 0.1.5__tar.gz → 0.1.7__tar.gz

{valanga-0.1.5 → valanga-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: valanga
-Version: 0.1.5
+Version: 0.1.7
 Summary: Shared types and utilities for evaluation
 Author-email: Victor Gabillon <victorgabillon@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE

{valanga-0.1.5 → valanga-0.1.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "valanga"
-version = "0.1.5"
+version = "0.1.7"
 description = "Shared types and utilities for evaluation"
 requires-python = ">=3.13"
 dependencies = []

{valanga-0.1.5 → valanga-0.1.7}/src/valanga/evaluations.py

@@ -5,6 +5,8 @@ Evaluation-related classes and types.
 from dataclasses import dataclass
 from typing import Protocol
 
+from valanga.evaluator_types import EvaluatorInput
+
 from .game import BranchKey, State
 from .over_event import OverEvent
 from .represention_for_evaluation import ContentRepresentation
@@ -22,7 +24,9 @@ class EvalItem[StateT: State](Protocol):
         ...
 
     @property
-    def state_representation(self) -> ContentRepresentation | None:
+    def state_representation(
+        self,
+    ) -> ContentRepresentation[StateT, EvaluatorInput] | None:
         """The representation of the state associated with this evaluation item, if available."""
         ...
 

valanga-0.1.7/src/valanga/representation_factory.py

@@ -0,0 +1,64 @@
+"""
+Factory for creating content representations from game states and state modifications.
+"""
+
+from dataclasses import dataclass
+from typing import Protocol
+
+from .game import State
+from .represention_for_evaluation import ContentRepresentation
+
+
+class CreateFromState[StateT: State, EvalIn](Protocol):
+    """
+    Protocol for creating a state representation from a state.
+    """
+
+    def __call__(self, state: StateT) -> ContentRepresentation[StateT, EvalIn]: ...
+
+
+class CreateFromStateAndModifications[StateT: State, EvalIn, StateModT](Protocol):
+    """
+    Protocol for creating a state representation from a state and modifications.
+    """
+
+    def __call__(
+        self,
+        state: StateT,
+        state_modifications: StateModT,
+        previous_state_representation: ContentRepresentation[StateT, EvalIn],
+    ) -> ContentRepresentation[StateT, EvalIn]: ...
+
+
+@dataclass
+class RepresentationFactory[StateT: State, EvalIn, StateModT]:
+    """Factory for creating content representations from states and state modifications.
+    Attributes:
+        create_from_state: Function to create a content representation from a state.
+        create_from_state_and_modifications: Function to create a content representation from a state and state modifications.
+    """
+
+    create_from_state: CreateFromState[StateT, EvalIn]
+    create_from_state_and_modifications: CreateFromStateAndModifications[
+        StateT, EvalIn, StateModT
+    ]
+
+    def create_from_transition(
+        self,
+        state: StateT,
+        previous_state_representation: ContentRepresentation[StateT, EvalIn] | None,
+        modifications: StateModT | None,
+    ) -> ContentRepresentation[StateT, EvalIn]:
+        """Creates a content representation from a state transition.
+        Args:
+            state: The current state of the game.
+            previous_state_representation: The content representation of the previous state, or None if not available.
+            modifications: The modifications applied to the previous state to reach the current state, or None if not available.
+        Returns:
+            ContentRepresentation[StateT, EvalIn]: The content representation of the current state.
+        """
+        if previous_state_representation is None or modifications is None:
+            return self.create_from_state(state)
+        return self.create_from_state_and_modifications(
+            state, modifications, previous_state_representation
+        )

{valanga-0.1.5 → valanga-0.1.7}/src/valanga/represention_for_evaluation.py

@@ -2,21 +2,26 @@
 Contains the definition of the ContentRepresentation protocol for content representations used in evaluations.
 """
 
-from typing import Any, Protocol, TypeVar
+from typing import Protocol, TypeVar
+
+from valanga.evaluator_types import EvaluatorInput
 
-from .evaluator_types import EvaluatorInput
 from .game import State
 
-StateT_contra = TypeVar("StateT_contra", bound=State, contravariant=True, default=Any)
+StateT_contra = TypeVar("StateT_contra", bound=State, contravariant=True, default=State)
+
+EvalIn_co = TypeVar(
+    "EvalIn_co", covariant=True, bound=EvaluatorInput, default=EvaluatorInput
+)
 
 
-class ContentRepresentation(Protocol[StateT_contra]):
+class ContentRepresentation[StateT_contra, EvalIn_co](Protocol):
     """
     Protocol defining the interface for a content representation.
     It is a function returning the proper input for evaluation by the content evaluator.
     """
 
-    def get_evaluator_input(self, state: StateT_contra) -> EvaluatorInput:
+    def get_evaluator_input(self, state: StateT_contra) -> EvalIn_co:
         """
         Returns the evaluator input tensor for the content. Content representations have generally a compressed view and complemetary view of state info so to avoid redundancy and have all the necessary info we also give the state as input.
 
@@ -26,3 +31,4 @@ class ContentRepresentation(Protocol[StateT_contra]):
         Returns:
             The evaluator input tensor.
         """
+        ...

{valanga-0.1.5 → valanga-0.1.7}/src/valanga.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: valanga
-Version: 0.1.5
+Version: 0.1.7
 Summary: Shared types and utilities for evaluation
 Author-email: Victor Gabillon <victorgabillon@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE

valanga-0.1.5/src/valanga/representation_factory.py

@@ -1,76 +0,0 @@
-"""
-Factory class for creating state representations.
-"""
-
-from dataclasses import dataclass
-from typing import Protocol
-
-from .game import State, StateModifications
-from .represention_for_evaluation import ContentRepresentation
-
-
-class CreateFromState[StateT: State, RepT: ContentRepresentation](Protocol):
-    """
-    Protocol for creating a state representation from a state.
-    """
-
-    def __call__(self, state: StateT) -> RepT: ...
-
-
-class CreateFromStateAndModifications[StateT: State, RepT: ContentRepresentation](
-    Protocol
-):
-    """
-    Protocol for creating a state representation from a state and modifications.
-    """
-
-    def __call__(
-        self,
-        state: StateT,
-        state_modifications: StateModifications,
-        previous_state_representation: RepT,
-    ) -> RepT: ...
-
-
-@dataclass
-class RepresentationFactory[StateT: State, RepT: ContentRepresentation]:
-    """
-    Factory class for creating state representations.
-    """
-
-    create_from_state: CreateFromState[StateT, RepT]
-    create_from_state_and_modifications: CreateFromStateAndModifications[StateT, RepT]
-
-    def create_from_transition(
-        self,
-        state: StateT,
-        previous_state_representation: RepT | None,
-        modifications: StateModifications | None,
-    ) -> RepT:
-        """
-        Create a Generic T_StateRepresentation object from a transition.
-
-        Args:
-            state (State): The current state of the game.
-            previous_state_representation (Representation364 | None): The representation of the previous state. None if this is the root node.
-            modifications (StateModifications | None): The modifications from the parent state to the current state. None if this is the root node.
-
-        Returns:
-            T_StateRepresentation: The created (Generic) Representation object
-
-        This version is supposed to be faster as it only modifies the previous state
-        representation with the last modification
-        """
-        if previous_state_representation is None:  # this is the root_node
-            representation = self.create_from_state(state=state)
-        else:
-            if modifications is None:
-                representation = self.create_from_state(state=state)
-            else:
-                representation = self.create_from_state_and_modifications(
-                    state=state,
-                    state_modifications=modifications,
-                    previous_state_representation=previous_state_representation,
-                )
-
-        return representation