Skip to content

StarlangSoftware/AnnotatedTree-Swift

Repository files navigation

Constituency TreeBank

A treebank is a corpus where the sentences in each language are syntactically (if necessary morphologically) annotated. In the treebanks, the syntactic annotation usually follows constituent and/or dependency structure.

Treebanks annotated for the syntactic or semantic structures of the sentences are essential for developing state-of-the-art statistical natural language processing (NLP) systems including part-of-speech-taggers, syntactic parsers, and machine translation systems. There are two main groups of syntactic treebanks, namely treebanks annotated for constituency (phrase structure) and the ones that are annotated for dependency structure.

Data Format

We extend the original format with the relevant information, given between curly braces. For example, the word 'problem' in a sentence in the standard Penn Treebank notation, may be represented in the data format provided below:

(NN problem)

After all levels of processing are finished, the data structure stored for the same word has the following form in the system.

(NN {turkish=sorunu} {english=problem} 
{morphologicalAnalysis=sorun+NOUN+A3SG+PNON+ACC}
{metaMorphemes=sorun+yH}
{semantics=TUR10-0703650})

As is self-explanatory, 'turkish' tag shows the original Turkish word; 'morphologicalanalysis' tag shows the correct morphological parse of that word; 'semantics' tag shows the ID of the correct sense of that word; 'namedEntity' tag shows the named entity tag of that word; 'propbank' tag shows the semantic role of that word for the verb synset id (frame id in the frame file) which is also given in that tag.

Annotated TreeBanks

Penn-Treebank (15 Words)

Penn-Treebank (20 Words)

Video Lectures

For Developers

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

Requirements

  • Xcode Editor
  • Git

Git

Install the latest version of Git.

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 AnnotatedSentence-Swift will be created. Or you can use below link for exploring the code:

git clone https://github.com/starlangsoftware/AnnotatedTree-Swift.git

Open project with XCode

To import projects from Git with version control:

  • XCode IDE, select Clone an Existing Project.

  • In the Import window, paste github URL.

  • Click Clone.

Result: The imported project is listed in the Project Explorer view and files are loaded.

Compile

From IDE

After being done with the downloading and opening project, select Build option from Product menu. After compilation process, user can run AnnotatedTree-Swift.

Detailed Description

TreeBankDrawable

To load an annotated TreeBank:

TreeBankDrawable(folder: String, pattern: String)

TreeBankDrawable(folder: String)

To access all the trees in a TreeBankDrawable:

for (int i = 0; i < a.sentenceCount(); i++){
	let parseTree = a[i]
	....
}

ParseTreeDrawable

To load a saved ParseTreeDrawable:

ParseTreeDrawable(url : URL)

is used. Usually it is more useful to load TreeBankDrawable as explained above than to load ParseTree one by one.

To find the node number of a ParseTreeDrawable:

nodeCount() -> Int

the leaf number of a ParseTreeDrawable:

leafCount() -> Int

the word count in a ParseTreeDrawable:

wordCount(excludeStopWords: Bool)- > Int

above methods can be used.

LayerInfo

Information of an annotated word is kept in LayerInfo class. To access the morphological analysis of the annotated word:

getMorphologicalParseAt(index: Int) -> MorphologicalParse

meaning of an annotated word:

getSemanticAt(index: Int) -> String

the shallow parse tag (e.g., subject, indirect object etc.) of annotated word:

getShallowParseAt(index: Int) -> String

the argument tag of the annotated word:

getArgumentAt(index: Int) -> Argument

the word count in a node:

int getNumberOfWords()

Cite

@inproceedings{yildiz-etal-2014-constructing,
	title = "Constructing a {T}urkish-{E}nglish Parallel {T}ree{B}ank",
	author = {Y{\i}ld{\i}z, Olcay Taner  and
  	Solak, Ercan  and
  	G{\"o}rg{\"u}n, Onur  and
  	Ehsani, Razieh},
	booktitle = "Proceedings of the 52nd Annual Meeting of the Association for Computational Linguistics (Volume 2: Short Papers)",
	month = jun,
	year = "2014",
	address = "Baltimore, Maryland",
	publisher = "Association for Computational Linguistics",
	url = "https://www.aclweb.org/anthology/P14-2019",
	doi = "10.3115/v1/P14-2019",
	pages = "112--117",
}

For Contibutors

Package.swift file

  1. Dependencies should be given w.r.t github.
    dependencies: [
        .package(name: "MorphologicalAnalysis", url: "https://github.com/StarlangSoftware/TurkishMorphologicalAnalysis-Swift.git", .exact("1.0.6"))],
  1. Targets should include direct dependencies, files to be excluded, and all resources.
    targets: [
        .target(
	dependencies: ["MorphologicalAnalysis"],
	exclude: ["turkish1944_dictionary.txt", "turkish1944_wordnet.xml",
	"turkish1955_dictionary.txt", "turkish1955_wordnet.xml",
	"turkish1959_dictionary.txt", "turkish1959_wordnet.xml",
	"turkish1966_dictionary.txt", "turkish1966_wordnet.xml",
	"turkish1969_dictionary.txt", "turkish1969_wordnet.xml",
	"turkish1974_dictionary.txt", "turkish1974_wordnet.xml",
	"turkish1983_dictionary.txt", "turkish1983_wordnet.xml",
	"turkish1988_dictionary.txt", "turkish1988_wordnet.xml",
	"turkish1998_dictionary.txt", "turkish1998_wordnet.xml"],
	resources:
[.process("turkish_wordnet.xml"),.process("english_wordnet_version_31.xml"),.process("english_exception.xml")]),
  1. Test targets should include test directory.
	.testTarget(
		name: "WordNetTests",
		dependencies: ["WordNet"]),

Data files

  1. Add data files to the project folder.

Swift files

  1. Do not forget to comment each function.
   /**
     * Returns the value to which the specified key is mapped.
     - Parameters:
        - id: String id of a key
     - Returns: value of the specified key
     */
    public func singleMap(id: String) -> String{
        return map[id]!
    }
  1. Do not forget to define classes as open in order to be able to extend them in other packages.
	open class Word : Comparable, Equatable, Hashable
  1. Function names should follow caml case.
	public func map(id: String)->String?
  1. Write getter and setter methods.
	public func getSynSetId() -> String{
	public func setOrigin(origin: String){
  1. Use separate test class extending XCTestCase for testing purposes.
final class WordNetTest: XCTestCase {
    var turkish : WordNet = WordNet()
    
    func testSize() {
        XCTAssertEqual(78326, turkish.size())
    }
  1. Enumerated types should be declared as enum.
public enum CategoryType : String{
    case MATHEMATICS
    case SPORT
    case MUSIC
  1. Implement == operator and hasher method for hashing purposes.
    public func hash(into hasher: inout Hasher) {
        hasher.combine(name)
    }
    public static func == (lhs: Relation, rhs: Relation) -> Bool {
        return lhs.name == rhs.name
    }
  1. Make classes Comparable for comparison, Equatable for equality, and Hashable for hashing check.
	open class Word : Comparable, Equatable, Hashable
  1. Implement < operator for comparison purposes.
    public static func < (lhs: Word, rhs: Word) -> Bool {
        return lhs.name < rhs.name
    }
  1. Implement description for toString method.
	open func description() -> String{
  1. Use Bundle and XMLParserDelegate for parsing Xml files.
	let url = Bundle.module.url(forResource: fileName, withExtension: "xml")
	var parser : XMLParser = XMLParser(contentsOf: url!)!
	parser.delegate = self
	parser.parse()

also use parser method.

public func parser(_ parser: XMLParser, didStartElement elementName: String, namespaceURI: String?, qualifiedName qName: String?, attributes attributeDict: [String : String])

About

Annotated constituency treebank library

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages