immuneML.presentation.html package
Submodules
immuneML.presentation.html.DatasetExportHTMLBuilder module
- class immuneML.presentation.html.DatasetExportHTMLBuilder.DatasetExportHTMLBuilder[source]
Bases:
object
- CSS_PATH = PosixPath('/Users/milenpa/PycharmProjects/BMIimmuneML/immuneML/presentation/html/templates/css/custom.css')
- static build(state: DatasetExportState) Path [source]
Function that builds the HTML files based on the Simulation state. :param state: SimulationState object including all details of the Simulation instruction
- Returns:
path to the main HTML file (which is located under state.result_path)
- static make_html_map(state: DatasetExportState, base_path: Path) dict [source]
immuneML.presentation.html.ExploratoryAnalysisHTMLBuilder module
- class immuneML.presentation.html.ExploratoryAnalysisHTMLBuilder.ExploratoryAnalysisHTMLBuilder[source]
Bases:
object
A class that will make a HTML file(s) out of ExploratoryAnalysisState object to show what analysis took place in the ExploratoryAnalysisInstruction.
- CSS_PATH = PosixPath('/Users/milenpa/PycharmProjects/BMIimmuneML/immuneML/presentation/html/templates/css/custom.css')
- static build(state: ExploratoryAnalysisState) Path [source]
Function that builds the HTML files based on the ExploratoryAnalysis state. :param state: ExploratoryAnalysisState object with details and results of the instruction
- Returns:
path to the main HTML file (which is located under state.result_path)
- static make_html_map(state: ExploratoryAnalysisState, base_path: Path) dict [source]
immuneML.presentation.html.HPHTMLBuilder module
- class immuneML.presentation.html.HPHTMLBuilder.HPHTMLBuilder[source]
Bases:
object
A class that will make HTML file(s) out of TrainMLModelState object to show what analysis took place in the TrainMLModel.
- CSS_PATH = PosixPath('/Users/milenpa/PycharmProjects/BMIimmuneML/immuneML/presentation/html/templates/css/custom.css')
- NUM_DIGITS = 3
- static build(state: TrainMLModelState = None) Path [source]
Function that builds the HTML files based on the HPOptimization state. :param state: HPOptimizationState object with all details on the optimization
- Returns:
path to the main HTML file (index.html which is located under state.result_path)
immuneML.presentation.html.HTMLBuilder module
immuneML.presentation.html.MLApplicationHTMLBuilder module
- class immuneML.presentation.html.MLApplicationHTMLBuilder.MLApplicationHTMLBuilder[source]
Bases:
object
- CSS_PATH = PosixPath('/Users/milenpa/PycharmProjects/BMIimmuneML/immuneML/presentation/html/templates/css/custom.css')
- static build(state: MLApplicationState = None) str [source]
- static make_html_map(state: MLApplicationState, base_path: Path) dict [source]
immuneML.presentation.html.MultiDatasetBenchmarkHTMLBuilder module
immuneML.presentation.html.SimulationHTMLBuilder module
- class immuneML.presentation.html.SimulationHTMLBuilder.SimulationHTMLBuilder[source]
Bases:
object
A class that will make a HTML file(s) out of SimulationState object to show what analysis took place in the SimulationInstruction.
- CSS_PATH = PosixPath('/Users/milenpa/PycharmProjects/BMIimmuneML/immuneML/presentation/html/templates/css/custom.css')
- static build(state: SimulationState) str [source]
Function that builds the HTML files based on the Simulation state. :param state: SimulationState object including all details of the Simulation instruction
- Returns:
path to the main HTML file (which is located under state.result_path)
- static make_html_map(state: SimulationState, base_path: Path) dict [source]
immuneML.presentation.html.SubsamplingHTMLBuilder module
- class immuneML.presentation.html.SubsamplingHTMLBuilder.SubsamplingHTMLBuilder[source]
Bases:
object
A class that will make a HTML file(s) out of SubsamplingState object to show what analysis took place in the SubsamplingInstruction.
- CSS_PATH = PosixPath('/Users/milenpa/PycharmProjects/BMIimmuneML/immuneML/presentation/html/templates/css/custom.css')
- static build(state: SubsamplingState) str [source]
Function that builds the HTML files based on the Subsampling state. :param state: SubsamplingState object including all details of the Subsampling instruction
- Returns:
path to the main HTML file (which is located under state.result_path)
- static make_html_map(state: SubsamplingState, base_path: Path) dict [source]
immuneML.presentation.html.Util module
- class immuneML.presentation.html.Util.Util[source]
Bases:
object
- static get_table_string_from_csv(csv_path: Path, separator: str = ',', has_header: bool = True) str [source]
- static get_table_string_from_csv_string(csv_string: str, separator: str = ',', has_header: bool = True) str [source]
- static update_report_paths(report_result: ReportResult, path: Path) ReportResult [source]