Add Python Hangman

PiperOrigin-RevId: 855999836
Change-Id: I4a02b014d3e10db99fd7c55023cb13a71ce5e8b8

Author: lanctot

open_spiel/integration_tests/playthroughs/python_hangman.txt

@@ -0,0 +1,160 @@
+game: python_hangman
+
+GameType.chance_mode = ChanceMode.EXPLICIT_STOCHASTIC
+GameType.dynamics = Dynamics.SEQUENTIAL
+GameType.information = Information.PERFECT_INFORMATION
+GameType.long_name = "Python Hangman"
+GameType.max_num_players = 1
+GameType.min_num_players = 1
+GameType.parameter_specification = ["max_num_incorrect_guesses", "word_list_file"]
+GameType.provides_information_state_string = True
+GameType.provides_information_state_tensor = False
+GameType.provides_observation_string = True
+GameType.provides_observation_tensor = True
+GameType.provides_factored_observation_string = False
+GameType.reward_model = RewardModel.TERMINAL
+GameType.short_name = "python_hangman"
+GameType.utility = Utility.GENERAL_SUM
+
+NumDistinctActions() = 26
+PolicyTensorShape() = [26]
+MaxChanceOutcomes() = 1
+GetParameters() = {max_num_incorrect_guesses=6,word_list_file=}
+NumPlayers() = 1
+MinUtility() = -106.0
+MaxUtility() = 126.0
+UtilitySum() = None
+ObservationTensorShape() = [9]
+ObservationTensorLayout() = TensorLayout.CHW
+ObservationTensorSize() = 9
+MaxGameLength() = 26
+ToString() = "python_hangman(max_num_incorrect_guesses=6,word_list_file=)"
+
+# State 0
+# Not started yet
+IsTerminal() = False
+History() = []
+HistoryString() = ""
+IsChanceNode() = True
+IsSimultaneousNode() = False
+CurrentPlayer() = -1
+InformationStateString(0) = ""
+ObservationString(0) = "Not started yet"
+ObservationTensor(0): ◯◯◯◯◯◯◯◯◯
+ChanceOutcomes() = [(0,0.04), (1,0.04), (2,0.04), (3,0.04), (4,0.04), (5,0.04), (6,0.04), (7,0.04), (8,0.04), (9,0.04), (10,0.04), (11,0.04), (12,0.04), (13,0.04), (14,0.04), (15,0.04), (16,0.04), (17,0.04), (18,0.04), (19,0.04), (20,0.04), (21,0.04), (22,0.04), (23,0.04), (24,0.04)]
+LegalActions() = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24]
+StringLegalActions() = ["Chance outcome 0: apple", "Chance outcome 1: banana", "Chance outcome 2: cat", "Chance outcome 3: dog", "Chance outcome 4: egg", "Chance outcome 5: fish", "Chance outcome 6: frog", "Chance outcome 7: giraffe", "Chance outcome 8: hippo", "Chance outcome 9: jackal", "Chance outcome 10: kangaroo", "Chance outcome 11: lemon", "Chance outcome 12: monkey", "Chance outcome 13: narwhal", "Chance outcome 14: orange", "Chance outcome 15: penguin", "Chance outcome 16: pineapple", "Chance outcome 17: pizza", "Chance outcome 18: quail", "Chance outcome 19: rabbit", "Chance outcome 20: snake", "Chance outcome 21: squirrel", "Chance outcome 22: tiger", "Chance outcome 23: unicorn", "Chance outcome 24: zebra"]
+
+# Apply action "Chance outcome 20: snake"
+action: 20
+
+# State 1
+# Word:             snake
+# Letters Revealed: _____
+# Letters Guessed:
+# Num guesses: 0
+IsTerminal() = False
+History() = [20]
+HistoryString() = "20"
+IsChanceNode() = False
+IsSimultaneousNode() = False
+CurrentPlayer() = 0
+InformationStateString(0) = "20"
+ObservationString(0) = "Letters Revealed: _____\nLetters Guessed:  \nNum guesses: 0\n"
+ObservationTensor(0): ◯◯◯◯◯◯◯◯◯
+Rewards() = [0]
+Returns() = [0]
+LegalActions() = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25]
+StringLegalActions() = ["Guess letter a", "Guess letter b", "Guess letter c", "Guess letter d", "Guess letter e", "Guess letter f", "Guess letter g", "Guess letter h", "Guess letter i", "Guess letter j", "Guess letter k", "Guess letter l", "Guess letter m", "Guess letter n", "Guess letter o", "Guess letter p", "Guess letter q", "Guess letter r", "Guess letter s", "Guess letter t", "Guess letter u", "Guess letter v", "Guess letter w", "Guess letter x", "Guess letter y", "Guess letter z"]
+
+# Apply action "Guess letter n"
+action: 13
+
+# State 2
+# Word:             snake
+# Letters Revealed: _n___
+# Letters Guessed:  n
+# Num guesses: 1
+IsTerminal() = False
+History() = [20, 13]
+HistoryString() = "20, 13"
+IsChanceNode() = False
+IsSimultaneousNode() = False
+CurrentPlayer() = 0
+InformationStateString(0) = "20, 13"
+ObservationString(0) = "Letters Revealed: _n___\nLetters Guessed:  n\nNum guesses: 1\n"
+ObservationTensor(0): ◯◯◯◯◯◯◯◯◯
+Rewards() = [1]
+Returns() = [1]
+LegalActions() = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25]
+StringLegalActions() = ["Guess letter a", "Guess letter b", "Guess letter c", "Guess letter d", "Guess letter e", "Guess letter f", "Guess letter g", "Guess letter h", "Guess letter i", "Guess letter j", "Guess letter k", "Guess letter l", "Guess letter m", "Guess letter o", "Guess letter p", "Guess letter q", "Guess letter r", "Guess letter s", "Guess letter t", "Guess letter u", "Guess letter v", "Guess letter w", "Guess letter x", "Guess letter y", "Guess letter z"]
+
+# Apply action "Guess letter k"
+action: 10
+
+# State 3
+# Word:             snake
+# Letters Revealed: _n_k_
+# Letters Guessed:  nk
+# Num guesses: 2
+IsTerminal() = False
+History() = [20, 13, 10]
+HistoryString() = "20, 13, 10"
+IsChanceNode() = False
+IsSimultaneousNode() = False
+CurrentPlayer() = 0
+InformationStateString(0) = "20, 13, 10"
+ObservationString(0) = "Letters Revealed: _n_k_\nLetters Guessed:  nk\nNum guesses: 2\n"
+ObservationTensor(0): ◯◯◯◯◯◯◯◯◯
+Rewards() = [1]
+Returns() = [2]
+LegalActions() = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25]
+StringLegalActions() = ["Guess letter a", "Guess letter b", "Guess letter c", "Guess letter d", "Guess letter e", "Guess letter f", "Guess letter g", "Guess letter h", "Guess letter i", "Guess letter j", "Guess letter l", "Guess letter m", "Guess letter o", "Guess letter p", "Guess letter q", "Guess letter r", "Guess letter s", "Guess letter t", "Guess letter u", "Guess letter v", "Guess letter w", "Guess letter x", "Guess letter y", "Guess letter z"]
+
+# Apply action "Guess letter j"
+action: 9
+
+# State 4
+# Apply action "Guess letter e"
+action: 4
+
+# State 5
+# Apply action "Guess letter w"
+action: 22
+
+# State 6
+# Apply action "Guess letter l"
+action: 11
+
+# State 7
+# Apply action "Guess letter r"
+action: 17
+
+# State 8
+# Apply action "Guess letter a"
+action: 0
+
+# State 9
+# Apply action "Guess letter d"
+action: 3
+
+# State 10
+# Apply action "Guess letter i"
+action: 8
+
+# State 11
+# Word:             snake
+# Letters Revealed: _nake
+# Letters Guessed:  nkjewlradi
+# Num guesses: 10
+IsTerminal() = True
+History() = [20, 13, 10, 9, 4, 22, 11, 17, 0, 3, 8]
+HistoryString() = "20, 13, 10, 9, 4, 22, 11, 17, 0, 3, 8"
+IsChanceNode() = False
+IsSimultaneousNode() = False
+CurrentPlayer() = -4
+InformationStateString(0) = "20, 13, 10, 9, 4, 22, 11, 17, 0, 3, 8"
+ObservationString(0) = "Letters Revealed: _nake\nLetters Guessed:  nkjewlradi\nNum guesses: 10\n"
+ObservationTensor(0): ◯◯◯◯◯◯◯◯◯
+Rewards() = [-101]
+Returns() = [-102]

open_spiel/python/CMakeLists.txt

@@ -229,6 +229,7 @@ set(PYTHON_TESTS ${PYTHON_TESTS}
   games/data_test.py
   games/dynamic_routing_test.py
   games/dynamic_routing_utils_test.py
+  games/hangman_test.py
   games/liars_poker_test.py
   games/pokerkit_wrapper_test.py
   games/team_dominoes_test.py

open_spiel/python/games/__init__.py

@@ -29,6 +29,7 @@
 from open_spiel.python.games import block_dominoes
 from open_spiel.python.games import chat_game
 from open_spiel.python.games import dynamic_routing
+from open_spiel.python.games import hangman
 from open_spiel.python.games import iterated_prisoners_dilemma
 from open_spiel.python.games import kuhn_poker
 from open_spiel.python.games import liars_poker