olcaytaner / semanticrolelabeling
Semantic Role Labeling Library
Package info
github.com/StarlangSoftware/SemanticRoleLabeling-Php
pkg:composer/olcaytaner/semanticrolelabeling
Requires
- ext-intl: *
- ext-mbstring: *
Requires (Dev)
- olcaytaner/annotatedsentence: 1.0.5
- olcaytaner/annotatedtree: 1.0.1
- olcaytaner/corpus: 1.0.2
- olcaytaner/dependencyparser: 1.0.0
- olcaytaner/dictionary: 1.0.1
- olcaytaner/framenet: 1.0.1
- olcaytaner/morphologicalanalysis: 1.0.1
- olcaytaner/namedentityrecognition: 1.0.0
- olcaytaner/parsetree: 1.0.2
- olcaytaner/propbank: 1.0.2
- olcaytaner/sentinet: 1.0.0
- olcaytaner/wordnet: 1.0.1
- phpunit/phpunit: 11.4.0
README
Task Definition
Semantic Role Labeling (SRL) is a well-defined task where the objective is to analyze propositions expressed by the verb. In SRL, each word that bears a semantic role in the sentence has to be identified. There are different types of arguments (also called ’thematic roles’) such as Agent, Patient, Instrument, and also of adjuncts, such as Locative, Temporal, Manner, and Cause. These arguments and adjuncts represent entities participating in the event and give information about the event characteristics.
In the field of SRL, PropBank is one of the studies widely recognized by the computational linguistics communities. PropBank is the bank of propositions where predicate- argument information of the corpora is annotated, and the semantic roles or arguments that each verb can take are posited.
Each verb has a frame file, which contains arguments applicable to that verb. Frame files may include more than one roleset with respect to the senses of the given verb. In the roleset of a verb sense, argument labels Arg0 to Arg5 are described according to the meaning of the verb. For the example below, the predicate is “announce” from PropBank, Arg0 is “announcer”, Arg1 is “entity announced”, and ArgM- TMP is “time attribute”.
[ARG0 Türk Hava Yolları] [ARG1 indirimli satışlarını] [ARGM-TMP bu Pazartesi] [PREDICATE açıkladı].
[ARG0 Turkish Airlines] [PREDICATE announced] [ARG1 its discounted fares] [ARGM-TMP this Monday].
The following Table shows typical semantic role types. Only Arg0 and Arg1 indicate the same thematic roles across different verbs: Arg0 stands for the Agent or Causer and Arg1 is the Patient or Theme. The rest of the thematic roles can vary across different verbs. They can stand for Instrument, Start point, End point, Beneficiary, or Attribute. Moreover, PropBank uses ArgM’s as modifier labels indicating time, location, temporal, goal, cause etc., where the role is not specific to a single verb group; it generalizes over the entire corpus instead.
| Tag | Meaning |
|---|---|
| Arg0 | Agent or Causer |
| ArgM-EXT | Extent |
| Arg1 | Patient or Theme |
| ArgM-LOC | Locatives |
| Arg2 | Instrument, start point, end point, beneficiary, or attribute |
| ArgM-CAU | Cause |
| ArgM-MNR | Manner |
| ArgM-DIS | Discourse |
| ArgM-ADV | Adverbials |
| ArgM-DIR | Directionals |
| ArgM-PNC | Purpose |
| ArgM-TMP | Temporals |
Data Annotation
Preparation
- Collect a set of sentences to annotate.
- Each sentence in the collection must be named as xxxx.yyyyy in increasing order. For example, the first sentence to be annotated will be 0001.train, the second 0002.train, etc.
- Put the sentences in the same folder such as Turkish-Phrase.
- Build the Java project and put the generated sentence-propbank-predicate.jar and sentence-propbank-argument.jar files into another folder such as Program.
- Put Turkish-Phrase and Program folders into a parent folder.
Predicate Annotation
- Open sentence-propbank-predicate.jar file.
- Wait until the data load message is displayed.
- Click Open button in the Project menu.
- Choose a file for annotation from the folder Turkish-Phrase.
- For each predicate word in the sentence, click the word, and choose PREDICATE tag for that word.
- Click one of the next buttons to go to other files.
Argument Annotation
- Open sentence-propbank-argument.jar file.
- Wait until the data load message is displayed.
- Click Open button in the Project menu.
- Choose a file for annotation from the folder Turkish-Phrase.
- For each word in the sentence, click the word, and choose correct argument tag for that word.
- Click one of the next buttons to go to other files.
Classification DataSet Generation
After annotating sentences, you can use DataGenerator package to generate classification dataset for the Semantic Role Labeling task.
Generation of ML Models
After generating the classification dataset as above, one can use the Classification package to generate machine learning models for the Semantic Role Labeling task.
Annotated DataSets
PropBank Annotation
Framenet Annotation
For Developers
You can also see Java, Python, Cython, Js, C#, Swift, or C++ repository.
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();