aquin.suppression_eval_check Namespace Reference

Functions
dict[str, Any]	_normalize_suppression_eval_result (dict[str, Any] result)
bool	has_suppression_eval_payload (dict[str, Any] result)
tuple[Path, Path]	write_suppression_eval_check (dict[str, Any] result, *, str|None tool_name, str|Path cwd)
None	_plot_suppression_eval_check (dict[str, Any] result, Path png_path)
None	_plot_suppression_scores (Any ax, list[dict[str, Any]] topics)
None	_plot_ratio_panel (Any ax, list[dict[str, Any]] topics)

Variables
str	_JSON_NAME = "suppression-eval-check.json"
str	_PNG_NAME = "suppression-eval-check.png"
dict	_STATUS_COLORS

Function Documentation

_normalize_suppression_eval_result()

dict[str, Any] _normalize_suppression_eval_result ( dict[str, Any] result )

protected

Definition at line 25 of file suppression_eval_check.py.

Referenced by has_suppression_eval_payload(), and write_suppression_eval_check().

_plot_ratio_panel()

None _plot_ratio_panel ( Any ax, list[dict[str, Any]] topics )

protected

Definition at line 140 of file suppression_eval_check.py.

Referenced by _plot_suppression_eval_check().

_plot_suppression_eval_check()

None _plot_suppression_eval_check ( dict[str, Any] result, Path png_path )

protected

Definition at line 74 of file suppression_eval_check.py.

References _plot_ratio_panel(), and _plot_suppression_scores().

Referenced by write_suppression_eval_check().

_plot_suppression_scores()

None _plot_suppression_scores ( Any ax, list[dict[str, Any]] topics )

protected

Definition at line 114 of file suppression_eval_check.py.

Referenced by _plot_suppression_eval_check().

has_suppression_eval_payload()

bool has_suppression_eval_payload

(

dict[str, Any]

result

)

Definition at line 46 of file suppression_eval_check.py.

References _normalize_suppression_eval_result().

write_suppression_eval_check()

tuple[Path, Path] write_suppression_eval_check	(	dict[str, Any]	result,
		*	,
		str | None	tool_name,
		str | Path	cwd )

Definition at line 53 of file suppression_eval_check.py.

References _normalize_suppression_eval_result(), and _plot_suppression_eval_check().

Variable Documentation

_JSON_NAME

str aquin.suppression_eval_check._JSON_NAME = "suppression-eval-check.json"

protected

Definition at line 15 of file suppression_eval_check.py.

_PNG_NAME

str aquin.suppression_eval_check._PNG_NAME = "suppression-eval-check.png"

protected

Definition at line 16 of file suppression_eval_check.py.

_STATUS_COLORS

dict aquin.suppression_eval_check._STATUS_COLORS

protected

Initial value:

=  {
    "suppressed": "#f87171",
    "softened": "#fbbf24",
    "unfiltered": "#34d399",
}

Definition at line 18 of file suppression_eval_check.py.