Skip to content

StarlangSoftware/TurkishNamedEntityRecognition-Js

Repository files navigation

Named Entity Recognition Task

In named entity recognition, one tries to find the strings within a text that correspond to proper names (excluding TIME and MONEY) and classify the type of entity denoted by these strings. The problem is difficult partly due to the ambiguity in sentence segmentation; one needs to extract which words belong to a named entity, and which not. Another difficulty occurs when some word may be used as a name of either a person, an organization or a location. For example, Deniz may be used as the name of a person, or - within a compound - it can refer to a location Marmara Denizi 'Marmara Sea', or an organization Deniz Taşımacılık 'Deniz Transportation'.

The standard approach for NER is a word-by-word classification, where the classifier is trained to label the words in the text with tags that indicate the presence of particular kinds of named entities. After giving the class labels (named entity tags) to our training data, the next step is to select a group of features to discriminate different named entities for each input word.

[ORG Türk Hava Yolları] bu [TIME Pazartesi'den] itibaren [LOC İstanbul] [LOC Ankara] hattı için indirimli satışlarını [MONEY 90 TL'den] başlatacağını açıkladı.

[ORG Turkish Airlines] announced that from this [TIME Monday] on it will start its discounted fares of [MONEY 90TL] for [LOC İstanbul] [LOC Ankara] route.

See the Table below for typical generic named entity types.

Tag Sample Categories
PERSON people, characters
ORGANIZATION companies, teams
LOCATION regions, mountains, seas
TIME time expressions
MONEY monetarial expressions

Video Lectures

For Developers

You can also see Java, Python, Cython, Swift, C, C++, or C# repository.

Requirements

Node.js

To check if you have a compatible version of Node.js installed, use the following command:

node -v

You can find the latest version of Node.js here.

Git

Install the latest version of Git.

Npm Install

npm install nlptoolkit-namedentityrecognition

Download Code

In order to work on code, create a fork from GitHub page. Use Git for cloning the code to your local or below line for Ubuntu:

git clone <your-fork-git-link>

A directory called util will be created. Or you can use below link for exploring the code:

git clone https://github.com/starlangsoftware/namedentityrecognition-js.git

Open project with Webstorm IDE

Steps for opening the cloned project:

  • Start IDE
  • Select File | Open from main menu
  • Choose Namedentityrecognition-Js file
  • Select open as project option
  • Couple of seconds, dependencies will be downloaded.

Detailed Description

Gazetteer

Bir Gazetter yüklemek için

Gazetteer(name: string, fileName: string)

Hazır Gazetteerleri kullanmak için

AutoNER()

Bir Gazetteer'de bir kelime var mı diye kontrol etmek için

contains(word: string):boolean

Cite

@INPROCEEDINGS{8093439,
author={B. {Ertopçu} and A. B. {Kanburoğlu} and O. {Topsakal} and O. {Açıkgöz} and A. T. {Gürkan} and B. {Özenç} and İ. {Çam} and B. {Avar} and G. {Ercan} 	and O. T. {Yıldız}},
booktitle={2017 International Conference on Computer Science and Engineering (UBMK)}, 
title={A new approach for named entity recognition}, 
year={2017},
volume={},
number={},
pages={474-479},
doi={10.1109/UBMK.2017.8093439}}

For Contibutors

package.json file

  1. main and types are important when this package will be imported.
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  1. Dependencies should be maximum (not only direct but also indirect references should also be given), everything directly in the code should be given here.
  "dependencies": {
    "nlptoolkit-corpus": "^1.0.12",
    "nlptoolkit-dictionary": "^1.0.14",
    "nlptoolkit-morphologicalanalysis": "^1.0.19",
    "nlptoolkit-xmlparser": "^1.0.7"
  }

tsconfig.json file

  1. Compiler flags currently includes nodeNext for importing.
  "compilerOptions": {
    "outDir": "dist",
    "module": "nodeNext",
    "sourceMap": true,
    "noImplicitAny": true,
    "removeComments": false,
    "declaration": true,
  },
  1. tests, node_modules and dist should be excluded.
  "exclude": [
    "tests",
    "node_modules",
    "dist"
  ]

index.ts file

  1. Should include all ts classes.
export * from "./CategoryType"
export * from "./InterlingualDependencyType"
export * from "./InterlingualRelation"
export * from "./Literal"

Data files

  1. Add data files to the project folder. Subprojects should include all data files of the parent projects.

Javascript files

  1. Classes should be defined as exported.
export class JCN extends ICSimilarity{
  1. Do not forget to comment each function.
    /**
     * Computes JCN wordnet similarity metric between two synsets.
     * @param synSet1 First synset
     * @param synSet2 Second synset
     * @return JCN wordnet similarity metric between two synsets
     */
    computeSimilarity(synSet1: SynSet, synSet2: SynSet): number {
  1. Function names should follow caml case.
    setSynSetId(synSetId: string){
  1. Write getter and setter methods.
    getRelation(index: number): Relation{
    setName(name: string){
  1. Use standard javascript test style.
describe('SimilarityPathTest', function() {
    describe('SimilarityPathTest', function() {
        it('testComputeSimilarity', function() {
            let turkish = new WordNet();
            let similarityPath = new SimilarityPath(turkish);
            assert.strictEqual(32.0, similarityPath.computeSimilarity(turkish.getSynSetWithId("TUR10-0656390"), turkish.getSynSetWithId("TUR10-0600460")));
            assert.strictEqual(13.0, similarityPath.computeSimilarity(turkish.getSynSetWithId("TUR10-0412120"), turkish.getSynSetWithId("TUR10-0755370")));
            assert.strictEqual(13.0, similarityPath.computeSimilarity(turkish.getSynSetWithId("TUR10-0195110"), turkish.getSynSetWithId("TUR10-0822980")));
        });
    });
});
  1. Enumerated types should be declared with enum.
export enum CategoryType {
    MATHEMATICS, SPORT, MUSIC, SLANG, BOTANIC,
    PLURAL, MARINE, HISTORY, THEOLOGY, ZOOLOGY,
    METAPHOR, PSYCHOLOGY, ASTRONOMY, GEOGRAPHY, GRAMMAR,
    MILITARY, PHYSICS, PHILOSOPHY, MEDICAL, THEATER,
    ECONOMY, LAW, ANATOMY, GEOMETRY, BUSINESS,
    PEDAGOGY, TECHNOLOGY, LOGIC, LITERATURE, CINEMA,
    TELEVISION, ARCHITECTURE, TECHNICAL, SOCIOLOGY, BIOLOGY,
    CHEMISTRY, GEOLOGY, INFORMATICS, PHYSIOLOGY, METEOROLOGY,
    MINERALOGY
}
  1. If there are multiple constructors for a class, define them as constructor1, constructor2, ..., then from the original constructor call these methods.
    constructor1(symbol: any){
    constructor2(symbol: any, multipleFile: MultipleFile) {
    constructor(symbol: any, multipleFile: MultipleFile = undefined) {
        if (multipleFile == undefined){
            this.constructor1(symbol);
        } else {
            this.constructor2(symbol, multipleFile);
        }
    }
  1. Importing should be done via import method with referencing the node-modules.
import {Corpus} from "nlptoolkit-corpus/dist/Corpus";
import {Sentence} from "nlptoolkit-corpus/dist/Sentence";
  1. Use xmlparser package for parsing xml files.
	var doc = new XmlDocument("test.xml")
	doc.parse()
	let root = doc.getFirstChild()
	let firstChild = root.getFirstChild()

Packages

 
 
 

Contributors