Merge branch 'master' into patch-1

Author: matthen

.github/workflows/python-package.yml

@@ -40,11 +40,12 @@ jobs:
         pip install pytest-cov
         pytest --cov=pysbd tests/ --color yes --cov-report=xml --cov-report=html
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v1.0.7
+      uses: codecov/codecov-action@v1
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         file: ./coverage.xml
         flags: unittests
         env_vars: OS,PYTHON
         name: codecov-umbrella
         fail_ci_if_error: true
+

CONTRIBUTING.md

@@ -52,7 +52,7 @@ the system author uses to tag our issues and pull requests.
 
 ## Contributing to the code base
 
-Happy to see you contibute to pySBD codebase. To help you get started and understand internals of pySBD, a good place to start is to refer to the implementation section of pySBD research paper (link to be added soon). Another great place for reference is to look at [merged pull requests](https://github.com/nipunsadvilkar/pySBD/pulls?q=is%3Apr+sort%3Aupdated-desc+is%3Amerged). Depending on the type of your contribution, refer to the assigned labels.
+Happy to see you contibute to pySBD codebase. To help you get started and understand internals of pySBD, a good place to start is to refer to the implementation section of [pySBD research paper](https://arxiv.org/abs/2010.09657). Another great place for reference is to look at [merged pull requests](https://github.com/nipunsadvilkar/pySBD/pulls?q=is%3Apr+sort%3Aupdated-desc+is%3Amerged). Depending on the type of your contribution, refer to the assigned labels.
 
 ### Getting started
 To make changes to pySBD's code base, you need to fork then clone the GitHub repository to your local machine. You'll need to make sure that you have a development environment consisting of a Python distribution including python 3+, pip and git installed.

README.md

@@ -1,3 +1,4 @@
+![PySBD logo](artifacts/pysbd_logo.png?raw=true "pysbd logo")
 # pySBD: Python Sentence Boundary Disambiguation (SBD)
 
 ![Python package](https://github.com/nipunsadvilkar/pySBD/workflows/Python%20package/badge.svg) [![codecov](https://codecov.io/gh/nipunsadvilkar/pySBD/branch/master/graph/badge.svg)](https://codecov.io/gh/nipunsadvilkar/pySBD) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://github.com/nipunsadvilkar/pySBD/blob/master/LICENSE) [![PyPi](https://img.shields.io/pypi/v/pysbd?color=blue&logo=pypi&logoColor=white)](https://pypi.python.org/pypi/pysbd) [![GitHub](https://img.shields.io/github/v/release/nipunsadvilkar/pySBD.svg?include_prereleases&logo=github&style=flat)](https://github.com/nipunsadvilkar/pySBD)
@@ -8,6 +9,21 @@ This project is a direct port of ruby gem - [Pragmatic Segmenter](https://github
 
 ![pysbd_code](artifacts/pysbd_code.png?raw=true "pysbd_code")
 
+## Highlights
+**'PySBD: Pragmatic Sentence Boundary Disambiguation'** a short research paper got accepted into 2nd Workshop for Natural Language Processing Open Source Software (NLP-OSS) at EMNLP 2020. </br>
+
+**Research Paper:**</br>
+
+https://arxiv.org/abs/2010.09657</br>
+
+**[Recorded Talk:](https://slideslive.com/38939754)**</br>
+
+[![pysbd_talk](artifacts/pysbd_talk.png)](https://slideslive.com/38939754)</br>
+
+**Poster:**</br>
+
+[![name](artifacts/pysbd_poster.png)](artifacts/pysbd_poster.png)
+
 ## Install
 
 **Python**
@@ -59,6 +75,24 @@ If you want to contribute new feature/language support or found a text that is i
 4.  Push to the branch (`git push origin my-new-feature`)
 5.  Create a new Pull Request
 
+## Citation
+If you use `pysbd` package in your projects or research, please cite [PySBD: Pragmatic Sentence Boundary Disambiguation](https://www.aclweb.org/anthology/2020.nlposs-1.15).
+```
+@inproceedings{sadvilkar-neumann-2020-pysbd,
+    title = "{P}y{SBD}: Pragmatic Sentence Boundary Disambiguation",
+    author = "Sadvilkar, Nipun  and
+      Neumann, Mark",
+    booktitle = "Proceedings of Second Workshop for NLP Open Source Software (NLP-OSS)",
+    month = nov,
+    year = "2020",
+    address = "Online",
+    publisher = "Association for Computational Linguistics",
+    url = "https://www.aclweb.org/anthology/2020.nlposs-1.15",
+    pages = "110--114",
+    abstract = "We present a rule-based sentence boundary disambiguation Python package that works out-of-the-box for 22 languages. We aim to provide a realistic segmenter which can provide logical sentences even when the format and domain of the input text is unknown. In our work, we adapt the Golden Rules Set (a language specific set of sentence boundary exemplars) originally implemented as a ruby gem pragmatic segmenter which we ported to Python with additional improvements and functionality. PySBD passes 97.92{\%} of the Golden Rule Set examplars for English, an improvement of 25{\%} over the next best open source Python tool.",
+}
+```
+
 ## Credit
 
 This project wouldn't be possible without the great work done by [Pragmatic Segmenter](https://github.com/diasks2/pragmatic_segmenter) team.