EitherAuditor

An EitherAuditor encodes the idea of success or failure. In the case of failure, (meaning a model could not produce a prediction) diagnostic information is encoded in the form of an EitherAuditorError. No diagnostic information is emitted when a "successful" prediction is produced, even if compromises were made in order to produce the prediction or problems like missing data were encountered.

To construct an EitherAuditor, use the apply factory methods in the companion object.

Created by ryan.deak on 10/2/17.

A: the type of value returned in the success case.

Linear Supertypes

MorphableAuditor[Either[EitherAuditorError, _], A, Either[EitherAuditorError, A]], Auditor[Either[EitherAuditorError, _], A, Either[EitherAuditorError, A]], AnyRef, Any

Abstract Value Members

abstract def aggregateDiagnostics(errorMsgs: Seq[String], missingVarNames: Set[String], subvalues: Seq[Either[EitherAuditorError, _]]): (Seq[String], Set[String], List[ModelIdentity])

(Possibly) aggregate the information from subvalues into the error messages, missing variable names and model IDs with problems
(Possibly) aggregate the information from subvalues into the error messages, missing variable names and model IDs with problems
errorMsgs
error messages from the current model failure.
missingVarNames
missing variable names from the current model failure.
subvalues
diagnostic information from submodel successes / failures.
returns
(possibly) aggregated errors, missing variable info, and IDs of submodels that couldn't produce predictions.

Attributes
protected[this]
abstract def changeTo[M]: EitherAuditor[M]

Construct a new EitherAuditor[M].
Construct a new EitherAuditor[M]. Notice this allows succeeds.
M
the type of success value in the new auditor.

Attributes
protected[this]

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def changeType[M](implicit arg0: RefInfo[M]): Some[EitherAuditor[M]]

Return an EitherAuditor for success type M.
Return an EitherAuditor for success type M.
M
type of values returned on success
returns
a new auditor. An EitherAuditor can be returned for any type M.

Definition Classes
EitherAuditor → MorphableAuditor
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def failure(modelId: ModelIdentity, errorMsgs: ⇒ Seq[String] = Nil, missingVarNames: ⇒ Set[String] = Set.empty, subvalues: Seq[Either[EitherAuditorError, _]] = Nil): Either[EitherAuditorError, A]

Definition Classes
EitherAuditor → Auditor
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def success(modelId: ModelIdentity, valueToAudit: A, errorMsgs: ⇒ Seq[String] = Nil, missingVarNames: ⇒ Set[String] = Set.empty, subvalues: Seq[Either[EitherAuditorError, _]] = Nil, prob: ⇒ Option[Float] = None): Either[EitherAuditorError, A]

Definition Classes
EitherAuditor → Auditor
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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( ... )

Related Docs: object EitherAuditor | package impl

sealed abstract class EitherAuditor[A] extends MorphableAuditor[Either[EitherAuditorError, _], A, Either[EitherAuditorError, A]]

Abstract Value Members

abstract def aggregateDiagnostics(errorMsgs: Seq[String], missingVarNames: Set[String], subvalues: Seq[Either[EitherAuditorError, _]]): (Seq[String], Set[String], List[ModelIdentity])

abstract def changeTo[M]: EitherAuditor[M]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def changeType[M](implicit arg0: RefInfo[M]): Some[EitherAuditor[M]]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def failure(modelId: ModelIdentity, errorMsgs: ⇒ Seq[String] = Nil, missingVarNames: ⇒ Set[String] = Set.empty, subvalues: Seq[Either[EitherAuditorError, _]] = Nil): Either[EitherAuditorError, A]

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def success(modelId: ModelIdentity, valueToAudit: A, errorMsgs: ⇒ Seq[String] = Nil, missingVarNames: ⇒ Set[String] = Set.empty, subvalues: Seq[Either[EitherAuditorError, _]] = Nil, prob: ⇒ Option[Float] = None): Either[EitherAuditorError, A]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from MorphableAuditor[Either[EitherAuditorError, _], A, Either[EitherAuditorError, A]]

Inherited from Auditor[Either[EitherAuditorError, _], A, Either[EitherAuditorError, A]]

Inherited from AnyRef

Inherited from Any

Ungrouped