rail.evaluation.dist_to_point_evaluator module

class rail.evaluation.dist_to_point_evaluator.DistToPointEvaluator

Bases: Evaluator

Evaluate the performance of a photo-z estimator against reference point estimate

Parameters:

  • output_mode ([str] default=default) – What to do with the outputs. The options are ‘default’, where outputs will be written to files and some returned, and ‘return’, where outputs will only be returned and not written.

  • metrics ([list] default=[]) – The metrics you want to evaluate.

  • exclude_metrics ([list] default=[]) – List of metrics to exclude

  • metric_config ([dict] default={}) – configuration of individual_metrics

  • chunk_size ([int] default=10000) – Number of objects per chunk for parallel processing or to evalute per loop in single node processing

  • seed ([float] default=None) – Random seed value to use for reproducible results.

  • force_exact ([bool] default=False) – Force the exact calculation. This will not allow parallelization

  • metric_integration_limits ([list] default=[0.0, 3.0]) – The default end points for calculating metrics on a grid.

  • dx ([float] default=0.01) – The default step size when calculating metrics on a grid.

  • quantile_grid ([list] (default=[...])) – The quantile value grid on which to evaluate the CDF values. (0, 1)

  • x_grid ([list] (default=[...])) – The x-value grid at which to evaluate the pdf values.

  • hdf5_groupname ([str] default=photometry) – name of hdf5 group for data, if None, then set to ‘’

  • reference_dictionary_key ([str] default=redshift) – The key in the truth dictionary where the redshift data is stored.

  • input (QPHandle (INPUT))

  • truth (TableHandle (INPUT))

  • output (Hdf5Handle (OUTPUT))

  • summary (Hdf5Handle (OUTPUT))

  • single_distribution_summary (QPDictHandle (OUTPUT))

entrypoint_function: str | None = 'evaluate'
inputs: list[tuple[str, type[DataHandle]]] = [('input', <class 'rail.core.data.QPHandle'>), ('truth', <class 'rail.core.data.TableHandle'>)]
interactive_function: str | None = 'dist_to_point_evaluator'
metric_base_class

alias of DistToPointMetric

name = 'DistToPointEvaluator'