peal.teachers.virelay_teacher.make_project

peal.teachers.virelay_teacher.make_project(dataset_file_path, attribution_database_file_path, analysis_file_path, label_map_file_path, project_name, dataset_name, dataset_down_sampling_method, dataset_up_sampling_method, model_name, attribution_name, analysis_name, output_file_path)[source]

Generates a ViRelAy project file.

Parameters:

  • dataset_file_path (str) – The path to the dataset HDF5 file.

  • attribution_database_file_path (str) – The path to the attribution HDF5 file.

  • analysis_file_path (str) – The path to the analysis HDF5 file.

  • label_map_file_path (str) – The path to the label map YAML file.

  • project_name (str) – The name of the project.

  • dataset_name (str) – The name of the dataset that the classifier was trained on.

  • dataset_down_sampling_method (str) – The method that is to be used to down-sample images from the dataset that are larger than the input to the model. Must be one of “none”, “center_crop”, or “resize”.

  • dataset_up_sampling_method (str) – The method that is to be used to up-sample images from the dataset that are smaller than the input to the model. Must be one of “none”, “fill_zeros”, “fill_ones”, “edge_repeat”, “mirror_edge”, “wrap_around”, or “resize”.

  • model_name (str) – The name of the classifier model on which the project is based.

  • attribution_name (str) – The name of the method that was used to compute the attributions.

  • analysis_name (str) – The name of the analysis that was performed on the attributions.

  • output_file_path (str) – The path to the YAML file into which the project will be saved.

Return type:

None