Skip to content

StarlangSoftware/ParseTree-Swift

Repository files navigation

Constituency TreeBanks

When one talks about the “success” of a Natural Language Processing solution, they often refer to its ability to analyse the semantic and syntactic structure of a given sentence. Such a solution is expected to be able to understand both the linear and hierarchical order of the words in a sentence, unveil embedded structures, illustrate syntactical relationships and have a firm grasp of the argument structure. In order to meet the expectations, cutting edge Natural Language Processing systems like parsers, POS taggers or machine translation systems make use of syntactically or semantically annotated treebanks. Such treebanks offer a deep look through the surface and into the logical form of sentences.

Annotated treebanks can be categorised as constituency treebanks and dependency treebanks. Constituency treebanks offers clarity through resolving structural ambiguities, and successfully illustrates the syntagmatic relations like adjunct, complement, predicate, internal argument, external argument and such.

The very first comprehensive annotated treebank, the Penn Treebank, was created for the English language and offers 40,000 annotated sentences. Following the Penn Treebank, numerous treebanks annotated for constituency structures were developed in different languages including French, German, Finnish, Hungarian, Chinese and Arabic.

TreeBank DataSets

Penn-Treebank 15 Words

Penn-Treebank 20 Words

Video Lectures

For Developers

You can also see Java, Python, Cython, C#, Js, C, 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 Util-Swift will be created. Or you can use below link for exploring the code:

git clone https://github.com/starlangsoftware/ParseTree-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 ParseTree-Swift.

Detailed Description

TreeBank

To load a TreeBank composed of saved ParseTrees from a folder:

TreeBank(folder: String)

To load trees with a specified pattern from a folder of trees:

TreeBank(folder: String, pattern: String)

the line above is used. For example,

let a = TreeBank("/mypath")

the line below is used to load trees under the folder "mypath" which is under the current folder. If only the trees with ".train" extension under the same folder are to be loaded:

let a = TreeBank("/mypath", ".train")

To iterate over the trees after the TreeBank is loaded:

for i in 0..<a.size() {
	let p = a.get(i)
}

a block of code like this can be useful.

ParseTree

To load a saved ParseTree:

ParseTree(file: URL)

is used. Usually it is more useful to load a TreeBank as explained above than loading the ParseTree one by one.

To find the node number of a ParseTree:

nodeCount()

leaf number of a ParseTree:

leafCount()

above methods can be used.

Cite

@INPROCEEDINGS{9259873,
author={N. {Kara} and B. {Marşan} and M. {Özçelik} and B. N. {Arıcan} and A. {Kuzgun} and N. {Cesur} and D. B. {Aslan} and O. T. {Yıldız}},
booktitle={2020 Innovations in Intelligent Systems and Applications Conference (ASYU)}, 
title={Creating A Syntactically Felicitous Constituency Treebank For Turkish}, 
year={2020},
volume={},
number={},
pages={1-6},
doi={10.1109/ASYU50717.2020.9259873}}

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

Constituency Parse Tree Library

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages