#format wiki
#language en
#acl +All:read Default
= Ruler =

This page offers the official [[http://creativecommons.org/licenses/by/3.0/deed.en_US|Creative Commons Attribution 3.0 Unported License]] release of the Ruler, a rule-based tool for performing Coreference Resolution (CR). By downloading the Ruler package you accept the conditions of that licence.

'''Principal developer:'''
[[MateuszKopec|Mateusz Kopeć]]<<BR>>
'''Authors:'''
[[MateuszKopec|Mateusz Kopeć]], [[MaciejOgrodniczuk|Maciej Ogrodniczuk]]<<BR>>
'''License:''' CC BY v.3

{{http://i.creativecommons.org/l/by/3.0/88x31.png}}

== Downloads ==

You may check out the source code from [[http://git.nlp.ipipan.waw.pl/core/ruler|git repository]].

The manual and description of Ruler is available [[http://git.nlp.ipipan.waw.pl/core/ruler/blob/master/doc/manual.pdf|here]].

== Maven ==
If you want to use Ruler as Maven dependency, in your {{{pom.xml}}} file:
 * add repository information:
{{{#!highlight xml
<repositories>
  ...
  <repository>
    <id>zil-maven-release-repo</id>
    <name>ZIL maven release repository</name>
    <url>http://maven.nlp.ipipan.waw.pl/content/repositories/releases</url>
  </repository>
  ...
</repositories>
}}}
 * and dependency information:
{{{#!highlight xml
<dependencies>
 ...
  <dependency>
    <groupId>pl.waw.ipipan.zil.core</groupId>
    <artifactId>ruler</artifactId>
    <version>1.3</version>
  </dependency>
 ...
</dependencies>
}}}
== Online demo ==

[[http://multiservice.nlp.ipipan.waw.pl/|Multiservice]] offers an online demo of Ruler. You need to select a chain of actions producing mentions, and then add Ruler as the last component. For example, try: Pantera, Spejd, Nerf, MentionDetector, Ruler

You may also want to see [[PolishCoreferenceTools|other Polish Coreference Tools]].

== Citing ==
When using Ruler, please cite the following articles:
<<BibMate(key, "ogro:kop:11:ltc","ogro:kop:11:daarc", omitYears=true)>>