spaCy/spacy/syntax/ner.pyx

494 lines
16 KiB
Cython
Raw Normal View History

2017-04-15 14:05:15 +03:00
# coding: utf-8
2015-02-02 08:38:52 +03:00
from __future__ import unicode_literals
2017-04-15 14:05:15 +03:00
from thinc.typedefs cimport weight_t
from thinc.extra.search cimport Beam
from collections import OrderedDict, Counter
2017-04-15 14:05:15 +03:00
from .stateclass cimport StateClass
from ._state cimport StateC
2015-03-09 08:46:22 +03:00
from .transition_system cimport Transition
from .transition_system cimport do_func_t
2017-10-27 20:45:57 +03:00
from ..gold cimport GoldParseC, GoldParse
from ..errors import Errors
2015-02-02 08:38:52 +03:00
cdef enum:
MISSING
BEGIN
IN
LAST
UNIT
OUT
ISNT
2015-02-02 08:38:52 +03:00
N_MOVES
2015-03-23 17:34:08 +03:00
MOVE_NAMES = [None] * N_MOVES
MOVE_NAMES[MISSING] = 'M'
MOVE_NAMES[BEGIN] = 'B'
MOVE_NAMES[IN] = 'I'
MOVE_NAMES[LAST] = 'L'
MOVE_NAMES[UNIT] = 'U'
MOVE_NAMES[OUT] = 'O'
MOVE_NAMES[ISNT] = 'x'
2015-02-02 08:38:52 +03:00
2015-03-09 08:46:22 +03:00
cdef do_func_t[N_MOVES] do_funcs
2015-06-10 08:09:17 +03:00
cdef bint _entity_is_sunk(StateClass st, Transition* golds) nogil:
if not st.entity_is_open():
2015-03-09 08:46:22 +03:00
return False
cdef const Transition* gold = &golds[st.E(0)]
2015-03-09 08:46:22 +03:00
if gold.move != BEGIN and gold.move != UNIT:
return True
elif gold.label != st.E_(0).ent_type:
2015-03-09 08:46:22 +03:00
return True
else:
return False
2015-08-09 03:31:53 +03:00
2015-03-09 08:46:22 +03:00
cdef class BiluoPushDown(TransitionSystem):
2017-05-27 23:50:21 +03:00
def __init__(self, *args, **kwargs):
TransitionSystem.__init__(self, *args, **kwargs)
2015-03-09 08:46:22 +03:00
@classmethod
def get_actions(cls, **kwargs):
actions = {
MISSING: Counter(),
BEGIN: Counter(),
IN: Counter(),
LAST: Counter(),
UNIT: Counter(),
OUT: Counter()
}
actions[OUT][''] = 1
for entity_type in kwargs.get('entity_types', []):
for action in (BEGIN, IN, LAST, UNIT):
actions[action][entity_type] = 1
moves = ('M', 'B', 'I', 'L', 'U')
2016-11-25 18:02:22 +03:00
for raw_text, sents in kwargs.get('gold_parses', []):
for (ids, words, tags, heads, labels, biluo), _ in sents:
for i, ner_tag in enumerate(biluo):
if ner_tag != 'O' and ner_tag != '-':
_, label = ner_tag.split('-', 1)
for action in (BEGIN, IN, LAST, UNIT):
actions[action][label] += 1
return actions
2015-03-09 08:46:22 +03:00
property action_types:
def __get__(self):
return (BEGIN, IN, LAST, UNIT, OUT)
2017-05-28 15:06:40 +03:00
def move_name(self, int move, attr_t label):
if move == OUT:
return 'O'
2017-05-27 23:50:21 +03:00
elif move == MISSING:
return 'M'
else:
return MOVE_NAMES[move] + '-' + self.strings[label]
2017-05-26 19:31:23 +03:00
def has_gold(self, GoldParse gold, start=0, end=None):
end = end or len(gold.ner)
if all([tag in ('-', None) for tag in gold.ner[start:end]]):
2017-05-26 19:31:23 +03:00
return False
else:
return True
def preprocess_gold(self, GoldParse gold):
2017-05-26 19:31:23 +03:00
if not self.has_gold(gold):
return None
for i in range(gold.length):
gold.c.ner[i] = self.lookup_transition(gold.ner[i])
return gold
def get_beam_annot(self, Beam beam):
entities = {}
probs = beam.probs
for i in range(beam.size):
2017-11-14 04:11:40 +03:00
state = <StateC*>beam.at(i)
if state.is_final():
self.finalize_state(state)
prob = probs[i]
2017-11-14 04:11:40 +03:00
for j in range(state._e_i):
start = state._ents[j].start
end = state._ents[j].end
label = state._ents[j].label
entities.setdefault((start, end, label), 0.0)
entities[(start, end, label)] += prob
return entities
2017-07-29 22:59:02 +03:00
def get_beam_parses(self, Beam beam):
parses = []
probs = beam.probs
for i in range(beam.size):
2017-11-14 04:11:40 +03:00
state = <StateC*>beam.at(i)
if state.is_final():
self.finalize_state(state)
2017-07-29 22:59:02 +03:00
prob = probs[i]
parse = []
2017-11-14 04:11:40 +03:00
for j in range(state._e_i):
start = state._ents[j].start
end = state._ents[j].end
label = state._ents[j].label
2017-07-29 22:59:02 +03:00
parse.append((start, end, self.strings[label]))
parses.append((prob, parse))
return parses
cdef Transition lookup_transition(self, object name) except *:
2017-05-28 19:09:27 +03:00
cdef attr_t label
2017-10-27 20:45:57 +03:00
if name == '-' or name is None:
2017-09-14 17:59:45 +03:00
return Transition(clas=0, move=MISSING, label=0, score=0)
elif name == '!O':
return Transition(clas=0, move=ISNT, label=0, score=0)
elif '-' in name:
move_str, label_str = name.split('-', 1)
# Hacky way to denote 'not this entity'
if label_str.startswith('!'):
label_str = label_str[1:]
move_str = 'x'
2017-05-28 15:06:40 +03:00
label = self.strings.add(label_str)
else:
move_str = name
label = 0
move = MOVE_NAMES.index(move_str)
if move == ISNT:
return Transition(clas=0, move=ISNT, label=label, score=0)
for i in range(self.n_moves):
if self.c[i].move == move and self.c[i].label == label:
return self.c[i]
else:
raise KeyError(Errors.E022.format(name=name))
2017-05-28 15:06:40 +03:00
cdef Transition init_transition(self, int clas, int move, attr_t label) except *:
2015-03-09 08:46:22 +03:00
# TODO: Apparent Cython bug here when we try to use the Transition()
# constructor with the function pointers
cdef Transition t
t.score = 0
t.clas = clas
t.move = move
t.label = label
if move == MISSING:
t.is_valid = Missing.is_valid
t.do = Missing.transition
t.get_cost = Missing.cost
elif move == BEGIN:
t.is_valid = Begin.is_valid
t.do = Begin.transition
t.get_cost = Begin.cost
elif move == IN:
t.is_valid = In.is_valid
t.do = In.transition
t.get_cost = In.cost
elif move == LAST:
t.is_valid = Last.is_valid
t.do = Last.transition
t.get_cost = Last.cost
elif move == UNIT:
t.is_valid = Unit.is_valid
t.do = Unit.transition
t.get_cost = Unit.cost
elif move == OUT:
t.is_valid = Out.is_valid
t.do = Out.transition
t.get_cost = Out.cost
else:
raise ValueError(Errors.E019.format(action=move, src='ner'))
2015-03-09 08:46:22 +03:00
return t
def add_action(self, int action, label_name, freq=None):
2017-10-07 20:02:40 +03:00
cdef attr_t label_id
if not isinstance(label_name, (int, long)):
label_id = self.strings.add(label_name)
else:
label_id = label_name
if action == OUT and label_id != 0:
return
if action == MISSING or action == ISNT:
return
# Check we're not creating a move we already have, so that this is
# idempotent
for trans in self.c[:self.n_moves]:
if trans.move == action and trans.label == label_id:
return 0
if self.n_moves >= self._size:
self._size *= 2
self.c = <Transition*>self.mem.realloc(self.c, self._size * sizeof(self.c[0]))
self.c[self.n_moves] = self.init_transition(self.n_moves, action, label_id)
self.n_moves += 1
if self.labels.get(action, []):
freq = min(0, min(self.labels[action].values()))
self.labels[action][label_name] = freq-1
else:
self.labels[action] = Counter()
self.labels[action][label_name] = -1
2017-10-07 20:02:40 +03:00
return 1
cdef int initialize_state(self, StateC* st) nogil:
2017-03-11 20:12:01 +03:00
# This is especially necessary when we use limited training data.
for i in range(st.length):
if st._sent[i].ent_type != 0:
with gil:
self.add_action(BEGIN, st._sent[i].ent_type)
self.add_action(IN, st._sent[i].ent_type)
self.add_action(UNIT, st._sent[i].ent_type)
self.add_action(LAST, st._sent[i].ent_type)
2015-06-02 00:05:25 +03:00
cdef class Missing:
@staticmethod
2017-05-28 15:06:40 +03:00
cdef bint is_valid(const StateC* st, attr_t label) nogil:
return False
@staticmethod
2017-05-28 15:06:40 +03:00
cdef int transition(StateC* s, attr_t label) nogil:
2015-06-10 08:09:17 +03:00
pass
2015-03-09 08:46:22 +03:00
@staticmethod
2017-05-28 15:06:40 +03:00
cdef weight_t cost(StateClass s, const GoldParseC* gold, attr_t label) nogil:
2015-03-09 08:46:22 +03:00
return 9000
cdef class Begin:
@staticmethod
2017-05-28 15:06:40 +03:00
cdef bint is_valid(const StateC* st, attr_t label) nogil:
# Ensure we don't clobber preset entities. If no entity preset,
# ent_iob is 0
cdef int preset_ent_iob = st.B_(0).ent_iob
if preset_ent_iob == 1:
return False
elif preset_ent_iob == 2:
return False
elif preset_ent_iob == 3 and st.B_(0).ent_type != label:
return False
# If the next word is B or O, we can't B now
elif st.B_(1).ent_iob == 2 or st.B_(1).ent_iob == 3:
return False
# If the current word is B, and the next word isn't I, the current word
# is really U
elif preset_ent_iob == 3 and st.B_(1).ent_iob != 1:
return False
# Don't allow entities to extend across sentence boundaries
elif st.B_(1).sent_start == 1:
return False
else:
return label != 0 and not st.entity_is_open()
@staticmethod
2017-05-28 15:06:40 +03:00
cdef int transition(StateC* st, attr_t label) nogil:
st.open_ent(label)
st.set_ent_tag(st.B(0), 3, label)
st.push()
st.pop()
@staticmethod
2017-05-28 15:06:40 +03:00
cdef weight_t cost(StateClass s, const GoldParseC* gold, attr_t label) nogil:
2015-06-10 07:57:41 +03:00
cdef int g_act = gold.ner[s.B(0)].move
2017-05-28 19:09:27 +03:00
cdef attr_t g_tag = gold.ner[s.B(0)].label
2015-06-05 18:11:26 +03:00
if g_act == MISSING:
return 0
2015-06-06 00:48:43 +03:00
elif g_act == BEGIN:
2015-02-02 08:38:52 +03:00
# B, Gold B --> Label match
return label != g_tag
# Support partial supervision in the form of "not this label"
elif g_act == ISNT:
return label == g_tag
2015-02-02 08:38:52 +03:00
else:
# B, Gold I --> False (P)
# B, Gold L --> False (P)
# B, Gold O --> False (P)
# B, Gold U --> False (P)
return 1
cdef class In:
@staticmethod
2017-05-28 15:06:40 +03:00
cdef bint is_valid(const StateC* st, attr_t label) nogil:
cdef int preset_ent_iob = st.B_(0).ent_iob
if preset_ent_iob == 2:
return False
elif preset_ent_iob == 3:
return False
2017-10-27 20:45:57 +03:00
# TODO: Is this quite right? I think it's supposed to be ensuring the
# gazetteer matches are maintained
elif st.B_(1).ent_iob != preset_ent_iob:
return False
# Don't allow entities to extend across sentence boundaries
elif st.B_(1).sent_start == 1:
return False
return st.entity_is_open() and label != 0 and st.E_(0).ent_type == label
2017-03-11 20:12:01 +03:00
@staticmethod
2017-05-28 15:06:40 +03:00
cdef int transition(StateC* st, attr_t label) nogil:
st.set_ent_tag(st.B(0), 1, label)
st.push()
st.pop()
@staticmethod
2017-05-28 15:06:40 +03:00
cdef weight_t cost(StateClass s, const GoldParseC* gold, attr_t label) nogil:
2015-06-05 18:11:26 +03:00
move = IN
2016-02-01 04:37:08 +03:00
cdef int next_act = gold.ner[s.B(1)].move if s.B(0) < s.c.length else OUT
2015-06-10 07:57:41 +03:00
cdef int g_act = gold.ner[s.B(0)].move
2017-05-28 15:06:40 +03:00
cdef attr_t g_tag = gold.ner[s.B(0)].label
cdef bint is_sunk = _entity_is_sunk(s, gold.ner)
2017-03-11 20:12:01 +03:00
2015-06-05 18:11:26 +03:00
if g_act == MISSING:
return 0
elif g_act == BEGIN:
2017-10-27 20:45:57 +03:00
# I, Gold B --> True
# (P of bad open entity sunk, R of this entity sunk)
return 0
2015-02-02 08:38:52 +03:00
elif g_act == IN:
2017-10-27 20:45:57 +03:00
# I, Gold I --> True
# (label forced by prev, if mismatch, P and R both sunk)
return 0
2015-02-02 08:38:52 +03:00
elif g_act == LAST:
# I, Gold L --> True iff this entity sunk and next tag == O
return not (is_sunk and (next_act == OUT or next_act == MISSING))
2015-02-02 08:38:52 +03:00
elif g_act == OUT:
# I, Gold O --> True iff next tag == O
return not (next_act == OUT or next_act == MISSING)
2015-02-02 08:38:52 +03:00
elif g_act == UNIT:
# I, Gold U --> True iff next tag == O
return next_act != OUT
# Support partial supervision in the form of "not this label"
elif g_act == ISNT:
return 0
2015-06-05 18:11:26 +03:00
else:
return 1
cdef class Last:
@staticmethod
2017-05-28 15:06:40 +03:00
cdef bint is_valid(const StateC* st, attr_t label) nogil:
if st.B_(1).ent_iob == 1:
return False
return st.entity_is_open() and label != 0 and st.E_(0).ent_type == label
@staticmethod
2017-05-28 15:06:40 +03:00
cdef int transition(StateC* st, attr_t label) nogil:
st.close_ent()
st.set_ent_tag(st.B(0), 1, label)
st.push()
st.pop()
@staticmethod
2017-05-28 15:06:40 +03:00
cdef weight_t cost(StateClass s, const GoldParseC* gold, attr_t label) nogil:
2015-06-05 18:11:26 +03:00
move = LAST
2015-06-10 07:57:41 +03:00
cdef int g_act = gold.ner[s.B(0)].move
2017-05-28 15:06:40 +03:00
cdef attr_t g_tag = gold.ner[s.B(0)].label
2017-03-11 20:12:01 +03:00
2015-06-05 18:11:26 +03:00
if g_act == MISSING:
return 0
elif g_act == BEGIN:
2015-02-02 08:38:52 +03:00
# L, Gold B --> True
return 0
2015-02-02 08:38:52 +03:00
elif g_act == IN:
# L, Gold I --> True iff this entity sunk
return not _entity_is_sunk(s, gold.ner)
2015-02-02 08:38:52 +03:00
elif g_act == LAST:
# L, Gold L --> True
return 0
2015-02-02 08:38:52 +03:00
elif g_act == OUT:
# L, Gold O --> True
return 0
2015-02-02 08:38:52 +03:00
elif g_act == UNIT:
# L, Gold U --> True
return 0
# Support partial supervision in the form of "not this label"
elif g_act == ISNT:
return 0
2015-06-05 18:11:26 +03:00
else:
return 1
cdef class Unit:
@staticmethod
2017-05-28 15:06:40 +03:00
cdef bint is_valid(const StateC* st, attr_t label) nogil:
cdef int preset_ent_iob = st.B_(0).ent_iob
if preset_ent_iob == 2:
return False
elif preset_ent_iob == 1:
return False
elif preset_ent_iob == 3 and st.B_(0).ent_type != label:
return False
elif st.B_(1).ent_iob == 1:
return False
return label != 0 and not st.entity_is_open()
@staticmethod
2017-05-28 15:06:40 +03:00
cdef int transition(StateC* st, attr_t label) nogil:
st.open_ent(label)
st.close_ent()
st.set_ent_tag(st.B(0), 3, label)
st.push()
st.pop()
@staticmethod
2017-05-28 15:06:40 +03:00
cdef weight_t cost(StateClass s, const GoldParseC* gold, attr_t label) nogil:
2015-06-10 07:57:41 +03:00
cdef int g_act = gold.ner[s.B(0)].move
2017-05-28 15:06:40 +03:00
cdef attr_t g_tag = gold.ner[s.B(0)].label
2015-06-05 18:11:26 +03:00
if g_act == MISSING:
return 0
elif g_act == UNIT:
2015-02-02 08:38:52 +03:00
# U, Gold U --> True iff tag match
return label != g_tag
# Support partial supervision in the form of "not this label"
elif g_act == ISNT:
return label == g_tag
2015-02-02 08:38:52 +03:00
else:
# U, Gold B --> False
# U, Gold I --> False
# U, Gold L --> False
# U, Gold O --> False
return 1
2015-02-02 08:38:52 +03:00
cdef class Out:
@staticmethod
2017-05-28 15:06:40 +03:00
cdef bint is_valid(const StateC* st, attr_t label) nogil:
cdef int preset_ent_iob = st.B_(0).ent_iob
if preset_ent_iob == 3:
return False
elif preset_ent_iob == 1:
return False
return not st.entity_is_open()
2015-02-02 08:38:52 +03:00
@staticmethod
2017-05-28 15:06:40 +03:00
cdef int transition(StateC* st, attr_t label) nogil:
st.set_ent_tag(st.B(0), 2, 0)
st.push()
st.pop()
2017-03-11 20:12:01 +03:00
@staticmethod
2017-05-28 15:06:40 +03:00
cdef weight_t cost(StateClass s, const GoldParseC* gold, attr_t label) nogil:
2015-06-10 07:57:41 +03:00
cdef int g_act = gold.ner[s.B(0)].move
2017-05-28 15:06:40 +03:00
cdef attr_t g_tag = gold.ner[s.B(0)].label
2015-03-09 08:46:22 +03:00
if g_act == ISNT and g_tag == 0:
return 1
elif g_act == MISSING or g_act == ISNT:
2015-06-05 18:11:26 +03:00
return 0
elif g_act == BEGIN:
# O, Gold B --> False
return 1
elif g_act == IN:
# O, Gold I --> True
return 0
elif g_act == LAST:
# O, Gold L --> True
return 0
elif g_act == OUT:
# O, Gold O --> True
return 0
elif g_act == UNIT:
# O, Gold U --> False
return 1
2015-06-05 18:11:26 +03:00
else:
return 1