Skip to content

Commit

Permalink
add package summary and usage to README.md (#10)
Browse files Browse the repository at this point in the history
* README.md updated.

* minor style update

Co-authored-by: fcakyon <34196005+fcakyon@users.noreply.github.com>
  • Loading branch information
devrimcavusoglu and fcakyon authored Jul 15, 2021
1 parent d35d034 commit fab3ceb
Showing 1 changed file with 39 additions and 8 deletions.
47 changes: 39 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,43 @@
<div align="center">
<h1>
jury
Jury
</h1>

<h4>
Evaluation for Neural Language Generation.
</h4>

Coming soon..

</div>

Simple tool/toolkit for evaluating NLG (Natural Language Generation) offering various automated metrics. Jury offers a smooth and easy-to-use interface. It uses huggingface/datasets package for underlying metric computation, and hence adding custom metric is easy as adopting `datasets.Metric`.

## <div align="center"> Installation </div>

Through pip,

pip install jury

or build from source,

git clone https://github.com/obss/jury.git
cd jury
python setup.py install

## <div align="center"> Usage </div>

### API Usage

It is only two lines of code to evaluate generated outputs.

from jury import Jury

jury = Jury()
scores = jury.evaluate(predictions, references)

Specify metrics you want to use on instantiation.

jury = Jury(metrics=["bleu", "meteor"])
scores = jury.evaluate(predictions, references)

### CLI Usage

Coming soon...

## <div align="center"> License </div>

Licensed under the [MIT](LICENSE) License.

0 comments on commit fab3ceb

Please sign in to comment.