pineforge_hpo.pareto.ParetoError Class Reference

Inheritance diagram for pineforge_hpo.pareto.ParetoError:

Public Member Functions
None	__init__ (self, str code, str detail, Iterable ids=(), Iterable names=())
	__reduce__ (self)
dict	document (self)

Public Attributes
	code
	detail
	ids
	names

Static Public Attributes
str	code
str	detail
tuple	ids
tuple	names

Detailed Description

A refusal of the Pareto front contract; ``code`` is one of ``CODES``.

``ids`` holds offending trial ids, ascending; ``names`` holds offending axis or
field names. Either may be empty.

Definition at line 108 of file pareto.py.

Constructor & Destructor Documentation

__init__()

None pineforge_hpo.pareto.ParetoError.__init__	(		self,
		str	code,
		str	detail,
		Iterable	ids = (),
		Iterable	names = ()
	)

Definition at line 120 of file pareto.py.

References pineforge_hpo.pareto.ParetoError.__init__().

Referenced by pineforge_hpo.pareto.ParetoError.__init__().

Member Function Documentation

__reduce__()

pineforge_hpo.pareto.ParetoError.__reduce__

(

self

)

Definition at line 135 of file pareto.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._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, and pineforge_hpo.walkforward.WalkforwardError.names.

document()

dict pineforge_hpo.pareto.ParetoError.document

(

self

)

The refused result document: the refusal and the offenders, no front.

Definition at line 138 of file pareto.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._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, and pineforge_hpo.walkforward.WalkforwardError.names.

Member Data Documentation

code [1/2]

str pineforge_hpo.pareto.ParetoError.code

static

Definition at line 115 of file pareto.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().

code [2/2]

pineforge_hpo.pareto.ParetoError.code

Definition at line 130 of file pareto.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().

detail [1/2]

str pineforge_hpo.pareto.ParetoError.detail

static

Definition at line 116 of file pareto.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().

detail [2/2]

pineforge_hpo.pareto.ParetoError.detail

Definition at line 131 of file pareto.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 [1/2]

tuple pineforge_hpo.pareto.ParetoError.ids

static

Definition at line 117 of file pareto.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 [2/2]

pineforge_hpo.pareto.ParetoError.ids

Definition at line 132 of file pareto.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 [1/2]

tuple pineforge_hpo.pareto.ParetoError.names

static

Definition at line 118 of file pareto.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 [2/2]

pineforge_hpo.pareto.ParetoError.names

Definition at line 133 of file pareto.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().

---

The documentation for this class was generated from the following file:

• pareto.py