PineForge HPO 1.11.0
Native hyperparameter optimization for PineForge strategies
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
pineforge_hpo.neighbourhood.NeighbourhoodError Class Reference
+ Inheritance diagram for pineforge_hpo.neighbourhood.NeighbourhoodError:

Public Member Functions

None __init__ (self, str code, str detail, Any ids=(), Any 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 neighbourhood analysis; ``code`` names the refused rule.

``ids`` holds the offending rows as (source_index, trial_id) pairs,
ascending; ``names`` holds offending dimension or parameter names. Either may
be empty. No number of the analysis accompanies a refusal.

Definition at line 100 of file neighbourhood.py.

Constructor & Destructor Documentation

◆ __init__()

None pineforge_hpo.neighbourhood.NeighbourhoodError.__init__ (   self,
str  code,
str  detail,
Any   ids = (),
Any   names = () 
)

Definition at line 113 of file neighbourhood.py.

References pineforge_hpo.neighbourhood.NeighbourhoodError.__init__().

Referenced by pineforge_hpo.neighbourhood.NeighbourhoodError.__init__().

Member Function Documentation

◆ __reduce__()

pineforge_hpo.neighbourhood.NeighbourhoodError.__reduce__ (   self)

Definition at line 128 of file neighbourhood.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.neighbourhood.NeighbourhoodError.document (   self) 
The refusal as a JSON-ready document that carries no number.

Definition at line 131 of file neighbourhood.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.neighbourhood.NeighbourhoodError.code
static

Definition at line 108 of file neighbourhood.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.neighbourhood.NeighbourhoodError.code

Definition at line 123 of file neighbourhood.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.neighbourhood.NeighbourhoodError.detail
static

Definition at line 109 of file neighbourhood.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.neighbourhood.NeighbourhoodError.detail

Definition at line 124 of file neighbourhood.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.neighbourhood.NeighbourhoodError.ids
static

Definition at line 110 of file neighbourhood.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.neighbourhood.NeighbourhoodError.ids

Definition at line 125 of file neighbourhood.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.neighbourhood.NeighbourhoodError.names
static

Definition at line 111 of file neighbourhood.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.neighbourhood.NeighbourhoodError.names

Definition at line 126 of file neighbourhood.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: