Inheritance diagram for pineforge_hpo.pbo.PboError:

Public Member Functions
None	__init__ (self, str code, str detail, Iterable[Any] ids=(), Iterable[str] names=(), *dict[str, int]\|None coverage=None, Iterable[dict[str, Any]]\|None refusals=None)

dict[str, Any]	document (self)

Public Attributes
	code

	detail

	ids

	names

	coverage

	refusals

Detailed Description

A refusal: a module-local ``pbo_`` code, one plain sentence, the offending trial ids and,
when a call parameter is the offender, its name.

``code`` and ``ids`` are those of the first kind of problem in the fixed priority order.
``refusals`` names every kind that was found, in that order, each with its ``count`` and its
offending ``ids`` (contract clause 3.5: counts per reason and offending ids), and
``coverage`` says how much of the declared roster the rows cover (``declared`` trials,
``supplied`` rows, ``usable`` declared trials whose row had no problem) when the rows were
examined, else None; a refusal raised after the rows were accepted, such as a zero variance
or a work figure above ``max_work``, carries it too. A refusal that was not found among rows
has the one entry of its own code, counting its ids (or 1 when it has none).

Definition at line 156 of file pbo.py.

Constructor & Destructor Documentation

◆ init()

None pineforge_hpo.pbo.PboError.__init__	(		self,
		str	code,
		str	detail,
		Iterable[Any]	ids = `()`,
		Iterable[str]	names = `()`,
		*dict[str, int] \| None	coverage = `None`,
		Iterable[dict[str, Any]] \| None	refusals = `None`
	)

Definition at line 170 of file pbo.py.

References pineforge_hpo.pbo.PboError.__init__().

Referenced by pineforge_hpo.pbo.PboError.__init__().

Member Function Documentation

◆ document()

dict[str, Any] pineforge_hpo.pbo.PboError.document ( self )

The refusal as a JSON-ready document; it carries no number of the analysis.

Definition at line 193 of file pbo.py.

References pineforge::hpo::HpoError.code(), pineforge_hpo.continuation.WarmStartError.code, pineforge_hpo.continuation.SpaceExhaustedError.code, pineforge_hpo.dsr.DsrError.code, pineforge_hpo.error.HpoError.code, pineforge_hpo.holdout.HoldoutError.code, pineforge_hpo.neighbourhood.NeighbourhoodError.code, pineforge_hpo.pareto.ParetoError.code, pineforge_hpo.pbo.PboError.code, pineforge_hpo.walkforward.WalkforwardError.code, pineforge_hpo.pbo.PboError.coverage, pineforge_hpo._rows.RowsError.detail, pineforge_hpo.dsr.DsrError.detail, pineforge_hpo.holdout.HoldoutError.detail, pineforge_hpo.neighbourhood.NeighbourhoodError.detail, pineforge_hpo.pareto.ParetoError.detail, pineforge_hpo.pbo.PboError.detail, pineforge_hpo.walkforward.WalkforwardError.detail, pineforge_hpo._rows.RowsError.ids, pineforge_hpo.dsr.DsrError.ids, pineforge_hpo.holdout.HoldoutError.ids, pineforge_hpo.neighbourhood.NeighbourhoodError.ids, pineforge_hpo.pareto.ParetoError.ids, pineforge_hpo.pbo.PboError.ids, pineforge_hpo.walkforward.WalkforwardError.ids, pineforge_hpo._rows.RowsError.names, pineforge_hpo.dsr.DsrError.names, pineforge_hpo.holdout.HoldoutError.names, pineforge_hpo.neighbourhood.NeighbourhoodError.names, pineforge_hpo.neighbourhood.Study.names, pineforge_hpo.pareto.ParetoError.names, pineforge_hpo.pbo.PboError.names, pineforge_hpo.walkforward.WalkforwardError.names, and pineforge_hpo.pbo.PboError.refusals.

Member Data Documentation

◆ code

pineforge_hpo.pbo.PboError.code

Definition at line 181 of file pbo.py.

Referenced by pineforge_hpo.dsr.DsrError.__reduce__(), pineforge_hpo.holdout.HoldoutError.__reduce__(), pineforge_hpo.neighbourhood.NeighbourhoodError.__reduce__(), pineforge_hpo.pareto.ParetoError.__reduce__(), pineforge_hpo.walkforward.WalkforwardError.__reduce__(), pineforge_hpo.dsr.DsrError.document(), pineforge_hpo.holdout.HoldoutError.document(), pineforge_hpo.neighbourhood.NeighbourhoodError.document(), pineforge_hpo.pareto.ParetoError.document(), pineforge_hpo.pbo.PboError.document(), and pineforge_hpo.walkforward.WalkforwardError.document().

◆ coverage

pineforge_hpo.pbo.PboError.coverage

Definition at line 185 of file pbo.py.

Referenced by pineforge_hpo.pbo.PboError.document().

◆ detail

pineforge_hpo.pbo.PboError.detail

Definition at line 182 of file pbo.py.

Referenced by pineforge_hpo._rows.RowsError.__reduce__(), pineforge_hpo.dsr.DsrError.__reduce__(), pineforge_hpo.holdout.HoldoutError.__reduce__(), pineforge_hpo.neighbourhood.NeighbourhoodError.__reduce__(), pineforge_hpo.pareto.ParetoError.__reduce__(), pineforge_hpo.walkforward.WalkforwardError.__reduce__(), pineforge_hpo.dsr.DsrError.document(), pineforge_hpo.holdout.HoldoutError.document(), pineforge_hpo.neighbourhood.NeighbourhoodError.document(), pineforge_hpo.pareto.ParetoError.document(), pineforge_hpo.pbo.PboError.document(), and pineforge_hpo.walkforward.WalkforwardError.document().

◆ ids

pineforge_hpo.pbo.PboError.ids

Definition at line 183 of file pbo.py.

Referenced by pineforge_hpo._rows.RowsError.__reduce__(), pineforge_hpo.dsr.DsrError.__reduce__(), pineforge_hpo.holdout.HoldoutError.__reduce__(), pineforge_hpo.neighbourhood.NeighbourhoodError.__reduce__(), pineforge_hpo.pareto.ParetoError.__reduce__(), pineforge_hpo.walkforward.WalkforwardError.__reduce__(), pineforge_hpo.dsr.DsrError.document(), pineforge_hpo.holdout.HoldoutError.document(), pineforge_hpo.neighbourhood.NeighbourhoodError.document(), pineforge_hpo.pareto.ParetoError.document(), pineforge_hpo.pbo.PboError.document(), and pineforge_hpo.walkforward.WalkforwardError.document().

◆ names

pineforge_hpo.pbo.PboError.names

Definition at line 184 of file pbo.py.

Referenced by pineforge_hpo._rows.RowsError.__reduce__(), pineforge_hpo.dsr.DsrError.__reduce__(), pineforge_hpo.holdout.HoldoutError.__reduce__(), pineforge_hpo.neighbourhood.NeighbourhoodError.__reduce__(), pineforge_hpo.pareto.ParetoError.__reduce__(), pineforge_hpo.walkforward.WalkforwardError.__reduce__(), pineforge_hpo.dsr.DsrError.document(), pineforge_hpo.holdout.HoldoutError.document(), pineforge_hpo.neighbourhood.NeighbourhoodError.document(), pineforge_hpo.pareto.ParetoError.document(), pineforge_hpo.pbo.PboError.document(), and pineforge_hpo.walkforward.WalkforwardError.document().

◆ refusals

pineforge_hpo.pbo.PboError.refusals

Definition at line 188 of file pbo.py.