<commit_before># DKPro Argumentation

Java framework for demonstration purposes of working with DKPro/UIMA typesystem for argumentation annotation and argumentation mining.

Version 0.0.2

## Installation

DKPro Argumentation is available from Maven Central. For working with the UIMA type system, add the following dependencies to your `pom.xml`

```
<dependency>
    <groupId>de.tudarmstadt.ukp.dkpro.argumentation.types</groupId>
    <artifactId>de.tudarmstadt.ukp.dkpro.argumentation.types</artifactId>
    <version>0.0.2</version>
</dependency>
```
## Modules

### de.tudarmstadt.ukp.dkpro.argumentation.types

The UIMA type system is the central part of DKPro Argumentation. It enables to annotate argument components and relations on top of the UIMA/DKPro framework.

The class hierarchy contains two central classes, ``ArgumentComponent`` and ``ArgumentRelation``.

[DKPro-argumentation type system hierarchy](dkpro-argumentation-typesystem-draw.io.png)

```
uima.tcas.Annotation
|
+- de.tudarmstadt.ukp.dkpro.argumentation.types.ArgumentUnit</name>
   |      typeValue: uima.cas.String (Field for storing type value)
   |      properties: uima.cas.String (Field for storing any additional information; String
   |                                   serialization of java Properties)
   |
   +- de.tudarmstadt.ukp.dkpro.argumentation.types.ArgumentComponent
   |  |
   |  +- de.tudarmstadt.ukp.dkpro.argumentation.types.Claim
   |  |       stance: uima.cas.String
   |  |
   |  +- de.tudarmstadt.ukp.dkpro.argumentation.types.Premise
   |  |  |
   |  |  +- de.tudarmstadt.ukp.dkpro.argumentation.types.Backing
   |  |
   |  +- de.tudarmstadt.ukp.dkpro.argumentation.types.Rebuttal
   |  |
   |  +- de.tudarmstadt.ukp.dkpro.argumentation.types.Refutation
   |  |
   |  +- de.tudarmstadt.ukp.dkpro.argumentation.types.Citation
   |  |
   |  +- de.tudarmstadt.ukp.dkpro.argumentation.types.MajorClaim
   |
   +- de.tudarmstadt.ukp.dkpro.argumentation.types.ArgumentRelation
      |      source: de.tudarmstadt.ukp.dkpro.argumentation.types.ArgumentUnit
      |      target: de.tudarmstadt.ukp.dkpro.argumentation.types.ArgumentUnit
      |
      +- de.tudarmstadt.ukp.dkpro.argumentation.types.Support
      |
      +- de.tudarmstadt.ukp.dkpro.argumentation.types.Attack
      |
      +- de.tudarmstadt.ukp.dkpro.argumentation.types.Detail
      |
      +- de.tudarmstadt.ukp.dkpro.argumentation.types.Same
```

### IO

Contains ``ArgumentDumpWriter`` class that debugs all argument annotations in a document to the file/stdout.

### Misc

Provides classes to easily operate with argument component annotations.<commit_msg>No issue. Hierarchy drawing fix.<commit_after># DKPro Argumentation

Java framework for demonstration purposes of working with DKPro/UIMA typesystem for argumentation annotation and argumentation mining.

Version 0.0.2

## Installation

DKPro Argumentation is available from Maven Central. For working with the UIMA type system, add the following dependencies to your `pom.xml`

```
<dependency>
    <groupId>de.tudarmstadt.ukp.dkpro.argumentation.types</groupId>
    <artifactId>de.tudarmstadt.ukp.dkpro.argumentation.types</artifactId>
    <version>0.0.2</version>
</dependency>
```
## Modules

### de.tudarmstadt.ukp.dkpro.argumentation.types

The UIMA type system is the central part of DKPro Argumentation. It enables to annotate argument components and relations on top of the UIMA/DKPro framework.

The class hierarchy contains two central classes, ``ArgumentComponent`` and ``ArgumentRelation``.

![DKPro-argumentation type system hierarchy](dkpro-argumentation-typesystem-draw.io.png)

### IO

Contains ``ArgumentDumpWriter`` class that debugs all argument annotations in a document to the file/stdout.

### Misc

Provides classes to easily operate with argument component annotations.
{'fraction_non_alphanumeric': 0.10180580999738288, 'fraction_numerical': 0.003140539125883277, 'mean_word_length': 3.81360201511335, 'pattern_counts': {'":': 0, '<': 20, '<?xml version=': 0, '>': 20, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6998606', 'n_tokens_mistral': 1233, 'n_tokens_neox': 1180, 'n_words': 272}