EitherAuditorError

Diagnostic information about failures encountered. This structure can be thought of as a flattened tree of failures. The tree is pruned one of two ways, it is either prune at the root, or pruned at the the first submodel successes encountered. The tree is pruned at the root if the auditor is created via EitherAuditor[A](aggregateDiagnostics = false).

If the auditor is created via EitherAuditor[A](aggregateDiagnostics = true), or simply EitherAuditor[A], then the trees are pruned at successes. For instance, imagine a model, model 1, that has submodels 2 and 5. Submodel 2 has submodels 3 and 4; submodel 5 has submodels 6 and 7. Let's say the following submodels fail: 1, 2, 4, 6, 7. Then, information would be aggregated as follows:

//          ORIGINAL        |       PRUNED      |       SIMPLIFIED
//  =====================================================================
//                          |                   |
//   1:F +-- 2:F +--  3:S   |   1 +-- 2 +-- /   |   1 --- 2 +
//       |       |          |     |     |       |           |
//       |       +--  4:F   |     |     +-- 4   |           +-- 4
//       |                  |     |             |
//       +-- 5:S +--  6:F   |     +-- / +-- /   |
//               |          |           |       |
//               +--  7:F   |           +-- /   |  DFS preorder: 1, 2, 4
//                          |                   |
//  =====================================================================

Notice because submodel 5 succeeds, error information about submodels 6 and 7 is disregarded because submodel 5 could recover from its submodels' errors.

So, in the event that diagnostics are aggregated, only information about submodels 1, 2, 4 should be contained in the EitherAuditorError returned by the EitherAuditor.

failureModelIds: a non-empty list of ModelIdentity instances of submodels that failed to produce a prediction. Since the top-level model must fail in order for an EitherAuditorError to be returned, this is a non-empty list. This non-empty list is in DFS preorder.
errorMsgs: messages indicating errors encountered.
missingVarNames: names of variables with missing data encountered in the model computation.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new EitherAuditorError(failureModelIds: ::[ModelIdentity], errorMsgs: Seq[String], missingVarNames: Set[String])

failureModelIds
a non-empty list of ModelIdentity instances of submodels that failed to produce a prediction. Since the top-level model must fail in order for an EitherAuditorError to be returned, this is a non-empty list. This non-empty list is in DFS preorder.
errorMsgs
messages indicating errors encountered.
missingVarNames
names of variables with missing data encountered in the model computation.

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val errorMsgs: Seq[String]

messages indicating errors encountered.
val failureModelIds: ::[ModelIdentity]

a non-empty list of ModelIdentity instances of submodels that failed to produce a prediction.
a non-empty list of ModelIdentity instances of submodels that failed to produce a prediction. Since the top-level model must fail in order for an EitherAuditorError to be returned, this is a non-empty list. This non-empty list is in DFS preorder.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val missingVarNames: Set[String]

names of variables with missing data encountered in the model computation.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

final case class EitherAuditorError(failureModelIds: ::[ModelIdentity], errorMsgs: Seq[String], missingVarNames: Set[String]) extends Product with Serializable

Instance Constructors

new EitherAuditorError(failureModelIds: ::[ModelIdentity], errorMsgs: Seq[String], missingVarNames: Set[String])

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

val errorMsgs: Seq[String]

val failureModelIds: ::[ModelIdentity]

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val missingVarNames: Set[String]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped