Class

edu.illinois.cs.cogcomp.saul.classifier

Learnable

Related Doc: package classifier

Permalink

abstract class Learnable[T <: AnyRef] extends LBJLearnerEquivalent with Logging

Represents an instance of a learnable model. Each Learnable instance is associated with a node instance in the data model graph.

T

Type of the data stored in node

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Learnable
  2. Logging
  3. LBJLearnerEquivalent
  4. LBJClassifierEquivalent
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Learnable(node: Node[T], parameters: Parameters = new Learner.Parameters)(implicit tag: ClassTag[T])

    Permalink

    node

    Node instance associated with the learnable model.

    parameters

    Parameters for the Learner used

    tag

    ClassTag of the type of data stored in node

Abstract Value Members

  1. abstract val classifier: Learner

    Permalink

    classifier need to be defined by the user

    classifier need to be defined by the user

    Definition Classes
    LearnableLBJLearnerEquivalentLBJClassifierEquivalent
  2. abstract def label: Property[T]

    Permalink

    Label property for users classifier

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def apply(example: AnyRef): String

    Permalink

    syntactic sugar to create simple calls to the function

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def combinedProperties: CombinedDiscreteProperty[T]

    Permalink

    filter out the label from the features

  8. def crossValidation(k: Int, splitPolicy: SplitPolicy = SplitPolicy.random, prediction: Property[T] = null, groundTruth: Property[T] = null, exclude: String = "", outputGranularity: Int = 0): Seq[Results]

    Permalink

    Run k fold cross validation using the training data.

    Run k fold cross validation using the training data. The strategy to split the instances can be set to SplitPolicy.random, SplitPolicy.sequential, SplitPolicy.kth or SplitPolicy.manual if the data splitting policy is not 'Manual', the number of folds must be greater than 1. Otherwise it's value doesn't really matter.

    k

    number of folds

    splitPolicy

    strategy to split the instances into k folds.

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def feature: List[Property[T]]

    Permalink
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def forget(): Unit

    Permalink
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def getClassNameForClassifier: String

    Permalink
  16. def getClassSimpleNameForClassifier: String

    Permalink
  17. def getExampleArray(example: Any): Array[AnyRef]

    Permalink
    Definition Classes
    LBJLearnerEquivalent
  18. def getLabelLexicon: Lexicon

    Permalink
    Definition Classes
    LBJLearnerEquivalent
  19. def getLabeler: Classifier

    Permalink
    Definition Classes
    LBJLearnerEquivalent
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. lazy val internalLogger: Logger

    Permalink
    Definition Classes
    Logging
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. var isTraining: Boolean

    Permalink
  24. def lbpFeatures: Classifier

    Permalink
  25. def lcFilePath: URL

    Permalink
  26. def learn(iteration: Int, data: Iterable[T]): Unit

    Permalink
  27. def learn(iteration: Int = 10, parser: Parser)(implicit dummyImplicit: DummyImplicit): Unit

    Permalink
  28. def learn(iteration: Int): Unit

    Permalink
  29. def learnWithDerivedInstances(numIterations: Int, featureVectors: Iterable[FeatureVector]): Unit

    Permalink
  30. def lexFilePath: URL

    Permalink
  31. def load(): Unit

    Permalink
  32. def load(lcFile: URL, lexFile: URL): Unit

    Permalink
  33. def load(lcFile: String, lexFile: String): Unit

    Permalink

    Loads the model and lexicon for the classifier.

    Loads the model and lexicon for the classifier. Looks up in the local file system and the files are not found, looks up in the classpath JARs.

    lcFile

    The path of the model file

    lexFile

    The path of the lexicon file

  34. object logger

    Permalink
    Definition Classes
    Logging
  35. object loggerConfig

    Permalink

    Simple logback configuration.

    Simple logback configuration. Hopefully this will be discoverable by just typing loggerConfig.[TAB]

    Examples: format: OFF

    loggerConfig.Logger("org.apache.spark").setLevel(Level.WARN)
    
    loggerConfig.Logger().addAppender(
      loggerConfig.newPatternLayoutEncoder("%-5level [%thread]: %message%n"),
      loggerConfig.newConsoleAppender
    )

    format: ON

    Definition Classes
    Logging
  36. var modelDir: String

    Permalink
  37. var modelSuffix: String

    Permalink

    If you have multiple versions/variations of the same classifier, you can set the following variable, in order to save each variation on different files with different suffixes

  38. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  39. def nextOf(properties: List[Property[T]]): Property[T]

    Permalink
  40. def nextWithIn[U <: AnyRef](datamodel: DataModel, properties: List[Property[T]])(implicit uTag: ClassTag[U]): Property[T]

    Permalink
  41. val node: Node[T]

    Permalink

    Node instance associated with the learnable model.

  42. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  43. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  44. def on(t: AnyRef): LHSFirstOrderEqualityWithValueLBP

    Permalink
    Definition Classes
    LBJLearnerEquivalent
  45. val parameters: Parameters

    Permalink

    Parameters for the Learner used

  46. def prevOf(properties: List[Property[T]]): Property[T]

    Permalink
  47. def prevWithIn[U <: AnyRef](datamodel: DataModel, property: Property[T]*)(implicit uTag: ClassTag[U]): Property[T]

    Permalink
  48. def printlnModel(): Unit

    Permalink

    This function prints a summary of the classifier

  49. def save(): Unit

    Permalink
  50. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  51. def test(testParser: Parser, prediction: Property[T], groundTruth: Property[T], exclude: String, outputGranularity: Int): Results

    Permalink
  52. def test(testData: Iterable[T] = null, prediction: Property[T] = null, groundTruth: Property[T] = null, exclude: String = ""): Results

    Permalink

    Test with given data, use internally

    Test with given data, use internally

    testData

    if the collection of data is not given it is derived from the data model based on its type

    prediction

    it is the property that we want to evaluate it if it is null then the prediction of the classifier is the default

    groundTruth

    it is the property that we want to evaluate the prediction against it, if it is null then the gold label derived from the classifier is used

    exclude

    it is the label that we want to exclude fro evaluation, this is useful for evaluating the multi-class classifiers when we need to measure overall F1 instead of accuracy and we need to exclude the negative class

    returns

    List of Results

  53. def test(): Results

    Permalink

    Test with the test data, retrieve internally

    Test with the test data, retrieve internally

    returns

    a Results object

  54. def testContinuous(testData: Iterable[T] = null): Unit

    Permalink

    Test with real-valued (continuous) data.

    Test with real-valued (continuous) data. Runs Spearman's and Pearson's correlations.

    testData

    The continuous data to test on

  55. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  56. def trainingInstances: Iterable[T]

    Permalink
  57. val useCache: Boolean

    Permalink

    Whether to use caching

  58. def using(properties: List[Property[T]]): List[Property[T]]

    Permalink
  59. def using(properties: Property[T]*): List[Property[T]]

    Permalink
  60. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. def window(before: Int, after: Int)(properties: List[Property[T]]): Property[T]

    Permalink
  64. def windowWithin[U <: AnyRef](datamodel: DataModel, before: Int, after: Int, properties: List[Property[T]])(implicit uTag: ClassTag[U], tTag: ClassTag[T]): Property[T]

    Permalink

    A windows of properties

    A windows of properties

    before

    always negative (or 0)

    after

    always positive (or 0)

Inherited from Logging

Inherited from LBJLearnerEquivalent

Inherited from LBJClassifierEquivalent

Inherited from AnyRef

Inherited from Any

Ungrouped