report

SPAREICE.report(output_dir, experiment, data)[source]

Test the performance of SPARE-ICE and plot it

Parameters:
  • output_dir – A path to a directory (does not need to exist). A subdirectory named experiment will be created there. All plots are stored to it.

  • experiment – A name for the experiment as a string. Will be included in the title of the plots and used as name for the subdirectory in output_dir.

  • data – A pandas.DataFrame object with the required input fields.

Returns:

None