splendor package

Subpackages

• splendor.agents package
  • Subpackages
    • splendor.agents.generic package
      • Submodules
      • splendor.agents.generic.first_move module
      • splendor.agents.generic.random module
      • splendor.agents.generic.timeout module
      • Module contents
    • splendor.agents.our_agents package
      • Subpackages
      • Submodules
      • splendor.agents.our_agents.minmax module
      • Module contents
  • Module contents
• splendor.splendor package
  • Subpackages
    • splendor.splendor.gym package
      • Subpackages
      • Module contents
  • Submodules
  • splendor.splendor.constants module
  • splendor.splendor.features module
    • agent_buying_power()
    • agent_won()
    • build_array()
    • diminish_return()
    • extract_cards()
    • extract_metrics()
    • extract_metrics_with_cards()
    • extract_reserved_cards()
    • get_agent()
    • get_color_encoder()
    • get_indices_access_by_color()
    • get_yellow_gem_index()
    • missing_gems_to_card()
    • normalize_metrics()
    • turns_made_by_agent()
    • turns_to_buy_card()
    • vectorize_card()
  • splendor.splendor.splendor_displayer module
    • AgentArea
      • AgentArea.set_agent_title()
      • AgentArea.update()
    • BoardArea
      • BoardArea.update()
    • GUIDisplayer
      • GUIDisplayer.EndGame()
      • GUIDisplayer.ExcuteAction()
      • GUIDisplayer.InitDisplayer()
      • GUIDisplayer.TimeOutWarning()
      • GUIDisplayer.close_window()
      • GUIDisplayer.end_fullscreen()
      • GUIDisplayer.get_selection()
      • GUIDisplayer.prime_action_box()
      • GUIDisplayer.toggle_fullscreen()
      • GUIDisplayer.user_input()
    • TextDisplayer
      • TextDisplayer.EndGame()
      • TextDisplayer.ExcuteAction()
      • TextDisplayer.InitDisplayer()
      • TextDisplayer.StartRound()
      • TextDisplayer.TimeOutWarning()
      • TextDisplayer.user_input()
    • can_buy()
    • make_label()
  • splendor.splendor.splendor_model module
    • Card
    • SplendorGameRule
      • SplendorGameRule.calScore()
      • SplendorGameRule.gameEnds()
      • SplendorGameRule.generatePredecessor()
      • SplendorGameRule.generateSuccessor()
      • SplendorGameRule.generate_return_combos()
      • SplendorGameRule.getLegalActions()
      • SplendorGameRule.initialGameState()
      • SplendorGameRule.noble_visit()
      • SplendorGameRule.resources_sufficient()
    • SplendorState
      • SplendorState.AgentState
      • SplendorState.BoardState
  • splendor.splendor.splendor_utils module
    • ActionToString()
    • AgentToString()
    • AgentTrace
    • BoardToString()
    • GemsToString()
    • convert_filename()
  • splendor.splendor.types module
    • BuyAction
      • BuyAction.card
      • BuyAction.noble
      • BuyAction.returned_gems
      • BuyAction.type
    • CollectAction
      • CollectAction.collected_gems
      • CollectAction.noble
      • CollectAction.returned_gems
      • CollectAction.type
    • ReserveAction
      • ReserveAction.collected_gems
      • ReserveAction.noble
      • ReserveAction.returned_gems
      • ReserveAction.type
    • YellowGemCount
      • YellowGemCount.yellow
  • splendor.splendor.utils module
    • LimitRoundsGameRule
      • LimitRoundsGameRule.gameEnds()
  • Module contents

Submodules

splendor.game module

class splendor.game.Game(GameRule, agent_list, num_of_agent, seed=1, time_limit=1, warning_limit=3, displayer=None, agents_namelist=['Alice', 'Bob'], interactive=False)

Bases: object

Run()

class splendor.game.GameReplayer(GameRule, replay, displayer=None)

Bases: object

Run()

splendor.general_game_runner module

class splendor.general_game_runner.HidePrint(flag, file_path, f_name)

Bases: object

splendor.general_game_runner.add_cwd_to_sys_path()

splendor.general_game_runner.get_commit_time(repo: Repo)

Returns the commit time based on the TIMEZONE

Parameters:

repo – the repository

Returns:

the commit time

splendor.general_game_runner.gitCloneTeam(team_info, output_path)

splendor.general_game_runner.is_git_repo(path)

splendor.general_game_runner.loadAgent(matches, superQuiet=True)

splendor.general_game_runner.loadParameter()

Processes the command used to run Yinsh from the command line.

splendor.general_game_runner.main()

The main function called when advance_model.py is run from the command line:

> python runner.py

See the usage string for more details.

> python runner.py –help

splendor.general_game_runner.run(options, msg)

splendor.template module

class splendor.template.Action

Bases: object

class splendor.template.Agent(_id)

Bases: object

SelectAction(actions, game_state, game_rule)

class splendor.template.Displayer

Bases: object

EndGame(game_state, scores)

ExcuteAction(i, move, game_state)

InitDisplayer(runner)

TimeOutWarning(runner, id)

class splendor.template.GameRule(num_of_agent=2)

Bases: object

calScore(game_state, agent_id)

gameEnds()

generateSuccessor(game_state, action, agent_id)

getCurrentAgentIndex()

getLegalActions(game_state, agent_id)

getNextAgentIndex()

initialGameState()

update(action)

class splendor.template.GameState(num_of_agent, agent_id)

Bases: object

splendor.utils module

splendor.utils.raiseNotDefined()

splendor.version module

Version retrieval utility.

splendor.version.get_version() → str

extract the package version using importlib.

Module contents