Skip to content

featurebyte.FeatureJobSettingAnalysis.download_report

download_report(
output_path: Union[str, Path, NoneType]=None,
overwrite: bool=False
) -> Path

Description

Downloads analysis report.

Parameters

  • output_path: Union[str, Path, NoneType]
    Location to save downloaded report

  • overwrite: bool
    default: False
    Overwrite the file if it already exists

Returns

  • Path

Raises

  • FileExistsError
    File already exists at output path

Examples

>>> analysis = fb.FeatureJobSettingAnalysis.get_by_id(<analysis_id>)
>>> analysis.download_report()