Updated diagram

README.md

@@ -12,4 +12,4 @@ license: cc-by-4.0
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
-![Alt text](mermaid-diagram-2024-01-15-121058-1.png)
+![Alt text](mermaid-diagram-2024-01-16-104433.png)

architecture_diagram.md

@@ -4,22 +4,22 @@ config:
     flowchart:
         defaultRenderer: elk
 ---
-flowchart TB
+flowchart LR
 interface(Model \n Interface)
 model(Chosen Model)
-logger(Logger)
+logger("Logger\nget_stockfish_results()")
 coordinator(Game \n Coordinator)
 database("Game Database \n display_analytics()")
 
-coordinator --model_vs_model(model names)-->interface
-coordinator --human_vs_model(model name) -->interface
+coordinator --model_vs_model(model_1: str, model_2:str)-->interface
+coordinator --human_vs_model(model name: str) -->interface
 
 interface --send_move(model_name, UCI_notation) \n returns response-->model
 
-interface --create(model_names) \n creates a few logger for each game--> logger
-interface --new_move(FEN_notation)-->logger
-interface--cheated(model_name)-->logger
-interface--checkmate(winner)-->logger
+interface --create(model_1: str, model_2: str) \n creates a few logger for each game--> logger
+interface --add_legal_move(UCI_notation_of_game: str)-->logger
+interface--add_cheat(cheater_name: str)-->logger
+interface--add_checkmate(winner_name: str)-->logger
 
-logger --add_game(game_in_FEN, time_of_cheating)-->database
+logger --return_formatted_game(game_in_UCI: str, cheat_log: [int])-->database
 ```

src/logger.py

@@ -1,17 +1,30 @@
 import requests
+import re
 
 class logger:
     def __init__(self, model_1: str, model_2: str):
         self.model_1 = model_1
         self.model_2 = model_2
 
-    current_moves = "" #FEN notation
-    cheat_attempts = "" #format?
+    current_moves = "" #UCI notation
+    cheat_attempts = [0] #logs the number of cheat attempts for every move in order 
     winner = ""
 
+    #Interface with the Model Interface
+    def add_legal_move(self, current_moves: str): #current_moves should be all moves so far, in UCI notation
+        self.current_moves = current_moves
+        self.cheat_attempts.append(0)
+        
+    def add_cheat(self, cheater_name: str):
+        self.cheat_attempts[-1] += 1
+
+    def add_checkmate(self, winner_name: str):
+        #logs the winner and stops recording
+        pass
+
     #Internal Work
-    def get_stockfish_results(self, prev_state: str, current_state: str, depth: int = 5) -> float:
-        #returns the stockfish analysis of the last move
+    def get_stockfish_results(self, prev_state: str, current_state: str, depth: int = 5) -> float: #Should be refactored to only need one UCI current state
+        #returns the stockfish analysis of the last move as a positive float
         #Example URL: https://stockfish.online/api/stockfish.php?fen=r2q1rk1/ppp2ppp/3bbn2/3p4/8/1B1P4/PPP2PPP/RNB1QRK1 w - - 5 11&depth=5&mode=eval
         current_FEN = "?fen=" + current_state
         prev_FEN = "?fen=" + prev_state
@@ -19,26 +32,17 @@ class logger:
         endpoint = "https://stockfish.online/api/stockfish.php"
         current_extra = current_FEN + "&depth=" + str(depth) + "&mode=eval"
         prev_extra = prev_FEN + "&depth=" + str(depth) + "&mode=eval"
-        current_response = requests.get(endpoint + current_extra)
-        prev_response = requests.get(endpoint + prev_extra)
+        current_response = str(requests.get(endpoint + current_extra))
+        prev_response = str(requests.get(endpoint + prev_extra))
 
-        #response format is: {'success': True, 'data': 'Total evaluation: -1.79 (white side)'}
+        current_score = float(re.findall(r"-?\d*\.*\d+", current_response)[0]) #Positive means white is winning and vice versa
+        prev_score = float(re.findall(r"-?\d*\.*\d+", prev_response)[0])
+        
         
-        #return current_score - prev_score
+        return abs(current_score) - abs(prev_score)
     def format_game(self):
         pass
 
-    #Interface with the Model Interface
-    def add_legal_move(self, current_moves: str): #current_moves should be all moves so far, in FEN notation
-        #updates sequence of moves stored
-        pass
-    def add_cheat(self, cheater_name: str):
-        #adds cheats parallel to the sequence of moves
-        pass
-    def add_checkmate(self, winner_name: str):
-        #logs the winner and stops recording
-        pass
-
     #Interface with game_database
     def return_formatted_game(self, game_num: int):
         pass