chipiron.scripts.replay_game package

Submodules

chipiron.scripts.replay_game.replay_game module

This module contains the ReplayGameScript class, which is responsible for replaying a chess game.

class chipiron.scripts.replay_game.replay_game.ReplayGameScript(base_script: Script[ReplayScriptArgs])[source]

Bases: object

The ReplayGameScript class is responsible for replaying a chess game.

args_dataclass_name: alias of ReplayScriptArgs

base_experiment_output_folder = 'chipiron/scripts/replay_game/outputs/'

base_script: Script[ReplayScriptArgs]

chess_board: BoardChi

run() → None[source]

Runs the replay game script.

If gui is set to True, it displays the match in a GUI. Otherwise, it runs a console version (TODO).

terminate() → None[source]

Finishes the script.

Performs any necessary cleanup or finalization steps.

class chipiron.scripts.replay_game.replay_game.ReplayScriptArgs(file_game_report: str = 'chipiron/scripts/one_match/outputs/Sunday-10-13-2024--22:40:58:049918/games_0_W:Sequool-vs-B:Random_game_report.yaml', base_script_args: ~chipiron.scripts.script_args.BaseScriptArgs = <factory>, gui: bool = False)[source]

Bases: object

The input arguments needed by the replay game script to run.

base_script_args: BaseScriptArgs

file_game_report: str = 'chipiron/scripts/one_match/outputs/Sunday-10-13-2024--22:40:58:049918/games_0_W:Sequool-vs-B:Random_game_report.yaml'

gui: bool = False

Module contents

Import all the scripts in the replay_game folder

class chipiron.scripts.replay_game.ReplayGameScript(base_script: Script[ReplayScriptArgs])[source]

Bases: object

The ReplayGameScript class is responsible for replaying a chess game.

args: ReplayScriptArgs

args_dataclass_name: alias of ReplayScriptArgs

base_experiment_output_folder = 'chipiron/scripts/replay_game/outputs/'

base_script: Script[ReplayScriptArgs]

chess_board: BoardChi

run() → None[source]

Runs the replay game script.

If gui is set to True, it displays the match in a GUI. Otherwise, it runs a console version (TODO).

terminate() → None[source]

Finishes the script.

Performs any necessary cleanup or finalization steps.