README

This resource allows for matching of Turkish words or expressions with their corresponding entries within the Turkish dictionary, the Turkish PropBank TRopBank, morphological analysis, named entity recognition, word senses from Turkish WordNet KeNet, shallow parsing, and universal dependency relation.

Data Format

The structure of a sample annotated word is as follows:

{turkish=Gelir}
{morphologicalAnalysis=gelir+NOUN+A3SG+PNON+NOM}
{metaMorphemes=gelir}
{semantics=TUR10-0289950}
{namedEntity=NONE}
{propbank=ARG0$TUR10-0798130}
{shallowParse=ÖZNE}
{universalDependency=10$NSUBJ}

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; 'shallowParse' tag shows the semantic role of that word; 'universalDependency' tag shows the index of the head word and the universal dependency for this 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.

For Developers

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

Php

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

php -V

You can find the latest version of Php here.

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

git clone https://github.com/starlangsoftware/AnnotatedSentence-Php.git

Open project with PhpStorm IDE

Steps for opening the cloned project:

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

For Contibutors

composer.json file

autoload is important when this package will be imported.

  "autoload": {
    "psr-4": {
      "olcaytaner\\WordNet\\": "src/"
    }
  },

Dependencies should be maximum (not only direct but also indirect references should also be given), everything directly in the code should be given here.

  "require-dev": {
    "phpunit/phpunit": "11.4.0",
    "olcaytaner/dictionary": "1.0.0",
    "olcaytaner/xmlparser": "1.0.1",
    "olcaytaner/morphologicalanalysis": "1.0.0"
  }

Data files

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

Php files

Do not forget to comment each function.

    /**
     * Returns true if specified semantic relation type presents in the relations list.
     *
     * @param SemanticRelationType $relationType element whose presence in the list is to be tested
     * @return bool true if specified semantic relation type presents in the relations list
     */
    public function containsRelationType(SemanticRelationType $relationType): bool{
        foreach ($this->relations as $relation){
            if ($relation instanceof SematicRelation && $relation->getRelationType() == $relationType){
                return true;
            }
        }
        return false;
    }

Function names should follow caml case.

    public function getRelation(int $index): Relation{

Write getter and setter methods.

    public function getOrigin(): ?string
    public function setName(string $name): void

Use standard javascript test style by extending the TestCase class. Use setup when necessary.

class WordNetTest extends TestCase
{
    private WordNet $turkish;

    protected function setUp(): void
    {
        ini_set('memory_limit', '450M');
        $this->turkish = new WordNet();
    }

    public function testSize()
    {
        $this->assertEquals(78327, $this->turkish->size());
    }

Enumerated types should be declared with enum.

enum CategoryType
{
    case MATHEMATICS;
    case SPORT;
    case MUSIC;
    case SLANG;
    case BOTANIC;

If there are multiple constructors for a class, define them as constructor1, constructor2, ..., then from the original constructor call these methods.

    public function constructor1(string $path, string $fileName): void
    public function constructor2(string $path, string $extension, int $index): void
    public function __construct(string $path, string $extension, ?int $index = null)

Use __toString method if necessary to create strings from objects.

    public function __toString(): string

Use xmlparser package for parsing xml files.

  $doc = new XmlDocument("../test.xml");
  $doc->parse();
  $root = $doc->getFirstChild();
  $firstChild = $root->getFirstChild();

olcaytaner / annotatedsentence

Maintainers

Package info

Statistics

Security