cc.factorie.app.uschema.KBDocuments.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of factorie_2.11 Show documentation

FACTORIE is a toolkit for deployable probabilistic modeling, implemented as a software library in Scala. It provides its users with a succinct language for creating relational factor graphs, estimating parameters and performing inference.

The newest version!

/* Copyright (C) 2008-2016 University of Massachusetts Amherst.
   This file is part of "FACTORIE" (Factor graphs, Imperative, Extensible)
   http://factorie.cs.umass.edu, http://github.com/factorie
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
    http://www.apache.org/licenses/LICENSE-2.0
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License. */
package cc.factorie.app.uschema

import com.google.common.collect.HashBiMap
import cc.factorie.app.nlp.{DocumentAnnotator, Document}
import cc.factorie.app.nlp.relation.RelationMentionList
import cc.factorie.app.nlp.{Document=>FactorieDocument}
import cc.factorie.app.nlp.ner.NerTag

case class MentionId(docid: String, startOffset: Int, length:Int)

trait XDocMention[T] {
  // identifies the document and offsets from which this mention came
  def mentionId: MentionId
  // some representation of the entity used to do XDoc coref
  // This stores of the necessary features.
  def features: T

  // predicted entity id
  def predictedEnt: Int

  // TODO: should this go into features?
  // TODO: or, should this be TAC type?
  def entityTag: NerTag

  // Maps kb name to link to kb entry.
  def kbLinks: Map[String, String]
}

trait XDocCorefSystem[T] {
  def generateXDocMentions(doc:FactorieDocument):Iterable[XDocMention[T]]
  def performCoref(mention:Iterator[XDocMention[T]]):Iterable[XDocMention[T]]
}

// TODO:
// do we need this?
// how do the relationmentions interact with the documents and the matrix?
trait KbDocuments {
  type EntityMap = HashBiMap[MentionId, Int]
  // - build the doc table
  // - build xDocMentions table
  def addDoc(doc: FactorieDocument)
  def documents: Iterator[FactorieDocument]
  // - use xDocMentions table (and maybe doc table)
  // - populates __entityMap
  // We should be able to share this implementation between Documents implementations
  def doXDocCoref[T](em: EntityMap, xcs: XDocCorefSystem[T]) {
    xcs.performCoref(documents.flatMap(xcs.generateXDocMentions)) foreach { ment =>
      em.put(ment.mentionId, ment.predictedEnt)
    }
  }
}

class MongoDocuments extends KbDocuments {
  def addDoc(doc: FactorieDocument) {
    throw new UnsupportedOperationException
  }
  def documents: Iterator[FactorieDocument] = {
    throw new UnsupportedOperationException
  }
}

class MemoryDocuments extends KbDocuments {
  def addDoc(doc: FactorieDocument) {
    throw new UnsupportedOperationException
  }
  def documents: Iterator[FactorieDocument] = {
    throw new UnsupportedOperationException
  }
}

trait RelationDocumentAnnotator extends DocumentAnnotator {
  def postAttrs = Seq(classOf[RelationMentionList])
  // def process(doc:Document)
}