/ww2-spacy

Primary LanguagePython

header for ww2 spacy

PyPI - PyPi

WW2 spaCy is a pipeline for processing primary and secondary sources for World War 2 and performing named entity recognition (NER). Currently, the pipeline is focused on United States-based military NER with plans to expand to include other countries in the near future. NOTE Updates are occuring frequently for this pipeline to expand its labels and the accuracy of the rules.

The pipeline is designed to not rely on machine learning so that it can remain modular, meaning a user can take a specific pipe and attach it to their own pipeline without issue. The main component is a SpanRuler that is used to identify and classify different military units, ships, planes, tanks, and battles. For a full list of entities, see below. Custom RegEx components are also used to identify military personnel. Finally, several custom components clean the spans to remove potential or likely false positives.

In order to disambiguate certain entities (e.g. 'the 1st'), a custom spaCy component (clean_spans) passes over each span and if there is ambiguity of a label, it gives priority to the longest span. If, however, spans are of equal length, no steps are taken to resolve the spans. This allows the user to disambiguate for themselves. This makes the pipeline a bit more delicate and focused than the filter_spans() function built in to spaCy.

Each data file can be found under 'assets'. The first line of each .txt file is the source(s) for the data. Most data came from lists available on Wikipedia.

Install

pip install en_ww2spacy

Usage

import spacy
from spacy import displacy

nlp = spacy.load("en_ww2spacy")

text = """The P-35 flew in WW2 at Battle of Point 175.
The 10th Armored Division was led by General William H. H. Morris.
It contained Sherman tanks. John Sherman is a false positive."""

doc = nlp(text)
displacy.render(doc, style="span", jupyter=True, options = {"spans_key": "ruler"})

example output

List of Entity Labels

MILITARY UNITS

AMERICAN

  • AIRBORN_DIVISION
  • ARMORED_DIVISION
  • ARMY_GROUP
  • BATTALION
  • CAVALRY
  • CORPS
  • FIELD_ARMY
  • INFANTRY_DIVISION
  • MOUNTAIN_DIVISION

EVENTS

MILITARY

  • BATTLE
  • OPERATION

PLACES

HOLOCAUST

  • CAMP
  • GHETTO

VEHICLES

AMERICAN

  • AMPHIBIOUS_VESSEL
  • BATTLESHIP
  • CARRIER
  • CARRIER_ESCORT
  • CRUISER
  • DESTROYER
  • FRIGATE_DESTROYER_ESCORT
  • GUNBOAT
  • MINE_VESSEL
  • PLANE
  • SUBMARINE
  • TANK

WEAPONS

AMERICAN

  • ANTI_TANK
  • BLADE
  • FLAMETHROWER
  • GRENADE
  • MACHINE_GUN
  • MORTAR
  • PISTOL
  • RIFLE
  • SHOTGUN
  • SUBMACHINE_GUN
  • PISTOL

MISC

  • MILITARY_PERSONNEL