xiangqipy.game_output_generator.GameOutputGenerator Class Reference

Outputs GameSummary to .json file, and saves plots to a .png file. More...

Collaboration diagram for xiangqipy.game_output_generator.GameOutputGenerator:

Public Member Functions
def	__init__ (self, GameSummary game_summary, str output_dir_suffix=None, Path custom_output_root=None)
Path	create_output_dir (self)
def	generate_output (self)

Public Attributes
	game_summary
	output_dir_suffix
	custom_output_root
	output_dir

Detailed Description

Outputs GameSummary to .json file, and saves plots to a .png file.

Definition at line 12 of file game_output_generator.py.

Constructor & Destructor Documentation

__init__()

def xiangqipy.game_output_generator.GameOutputGenerator.__init__	(		self,
		GameSummary	game_summary,
		str	output_dir_suffix = None,
		Path	custom_output_root = None
	)

Definition at line 17 of file game_output_generator.py.

Member Function Documentation

create_output_dir()

Path xiangqipy.game_output_generator.GameOutputGenerator.create_output_dir

(

self

)

Definition at line 30 of file game_output_generator.py.

generate_output()

def xiangqipy.game_output_generator.GameOutputGenerator.generate_output

(

self

)

Definition at line 52 of file game_output_generator.py.

Member Data Documentation

custom_output_root

xiangqipy.game_output_generator.GameOutputGenerator.custom_output_root

Definition at line 26 of file game_output_generator.py.

game_summary

xiangqipy.game_output_generator.GameOutputGenerator.game_summary

Definition at line 24 of file game_output_generator.py.

output_dir

xiangqipy.game_output_generator.GameOutputGenerator.output_dir

Definition at line 27 of file game_output_generator.py.

output_dir_suffix

xiangqipy.game_output_generator.GameOutputGenerator.output_dir_suffix

Definition at line 25 of file game_output_generator.py.

---

The documentation for this class was generated from the following file:

• src/xiangqipy/game_output_generator.py