edu.stanford.nlp.tmt.learn

Modeler

trait Modeler [ModelParams, Model, ModelState, DatumParams, Datum, DatumState] extends AnyRef

A Modeler holds a model and a set of data items, allowing certain operations to be performed in aggregate on that data.

Linear Supertypes
AnyRef, Any
Known Subclasses
SerialModeler, ThreadedModeler
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Modeler
  2. AnyRef
  3. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. def addData (dps: Iterable[DatumParams]): Unit

    Adds the given data items.

    Adds the given data items.

    Attributes
    abstract

  2. def clearData (): Unit

    Clears all data items.

    Clears all data items.

    Attributes
    abstract

  3. def clearDataState (): Unit

    Clears the state of all data items (but does not remove them).

    Clears the state of all data items (but does not remove them).

    Attributes
    abstract

  4. def clearModelState (): Unit

    Clears the model state (re-initializes).

    Clears the model state (re-initializes).

    Attributes
    abstract

  5. def companion : ModelCompanion[ModelParams, Model, ModelState, DatumParams, Datum, DatumState]

    Model companion used by this modeler.

    Model companion used by this modeler.

    Attributes
    abstract

  6. def description : String

    Description of the model being trained.

    Description of the model being trained.

    Attributes
    abstract

  7. def getData : Iterable[Datum]

    Returns all data items.

    Returns all data items.

    Attributes
    abstract

  8. def getDataSize (): Int

    Returns the number of data items available.

    Returns the number of data items available.

    Attributes
    abstract

  9. def getDataState : Iterable[DatumState]

    Returns the state of all data items.

    Returns the state of all data items.

    Attributes
    abstract

  10. def getModelParams : ModelParams

    Attributes
    abstract

  11. def getModelState : ModelState

    Gets the current model state.

    Gets the current model state.

    Attributes
    abstract

  12. def initialize (mp: ModelParams): Unit

    Clears all documents and begins using the given model.

    Clears all documents and begins using the given model.

    Attributes
    abstract

  13. def learnIteration (): Unit

    Does one iteration of learning.

    Does one iteration of learning.

    Attributes
    abstract

  14. def model : Option[Model]

    Returns the current model, if one has been initialized.

    Returns the current model, if one has been initialized.

    Attributes
    abstract

  15. def useDataState (dss: Iterable[DatumState]): Unit

    Uses the given data state.

    Uses the given data state.

    Attributes
    abstract

  16. def useModelState (ms: ModelState): Unit

    Uses the given ModelState in the current model.

    Uses the given ModelState in the current model.

    Attributes
    abstract

Concrete Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any

  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any

  7. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  8. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  9. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  11. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any

  12. def getMappedDataState [X] (f: (DatumState) ⇒ X)(implicit arg0: ReadWritable[X]): Iterable[X]

    Returns a function of the given data states.

  13. def hashCode (): Int

    Definition Classes
    AnyRef → Any

  14. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any

  15. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  16. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  17. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef

  18. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  19. def toString (): String

    Definition Classes
    AnyRef → Any

  20. def train (mp: ModelParams, data: Iterable[DatumParams], output: File = null, saveDataState: Boolean = true, maxIterations: Int = 1, outputIterations: Option[Int] = Some(50))(implicit msrw: ReadWritable[ModelState], mprw: ReadWritable[ModelParams], dr: TableRowReadable[DatumState], dw: TableRowWritable[DatumState]): Unit

    Train the model on the given data.

  21. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  22. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  23. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any