QED -- v0.0.150

Author: suzgunmirac

README.md

@@ -8,7 +8,7 @@
 [![PyPI version](https://badge.fury.io/py/string2string.svg)](https://badge.fury.io/py/string2string)
 [![Downloads](https://pepy.tech/badge/string2string)](https://pepy.tech/project/string2string)
 [![license](https://img.shields.io/github/license/stanfordnlp/string2string.svg)](https://github.com/stanfordnlp/string2string/blob/main/LICENSE.txt)
-[![arXiv](https://img.shields.io/badge/arXiv-2211.07634-b31b1b.svg)](https://arxiv.org/abs/2211.07634)
+[![arXiv](https://img.shields.io/badge/arXiv-2304.14395-b31b1b.svg)](https://arxiv.org/abs/2304.14395)
 
 ## Table of Contents
 
@@ -333,14 +333,14 @@ This code snippet shows how to utilize the BARTScore and BERTScore metrics to co
 @article{suzgun2023string2string,
   title={string2string: A Modern Python Library for String-to-String Algorithms},
   author={Suzgun, Mirac and Shieber, Stuart M and Jurafsky, Dan},
-  journal={arXiv preprint arXiv:[TBD].[TBD]},
+  journal={arXiv preprint arXiv:2304.14395},
   year={2023}
 }
 ```
 
 ## Thanks
 
-Our project owes a debt of gratitude to the following individuals for their contributions, comments, and feedback: Federico Bianchi, Corinna Coupette, Sebastian Gehrmann, Tayfun Gür, Şule Kahraman, Deniz Keleş, Luke Melas-Kyriazi, Tolúlopé Ògúnrèmí, Alexander "Sasha" Rush, Kyle Swanson, and Garrett Tanzer.
+Our project owes a debt of gratitude to the following individuals for their contributions, comments, and feedback: Federico Bianchi, Corinna Coupette, Sebastian Gehrmann, Tayfun Gür, Şule Kahraman, Deniz Keleş, Luke Melas-Kyriazi, Christopher Manning, Tolúlopé Ògúnrèmí, Alexander "Sasha" Rush, Kyle Swanson, and Garrett Tanzer.
 
 ## Contributing
 

docs/index.rst

@@ -6,13 +6,6 @@
 Welcome to string2string's documentation!
 =========================================
 
-.. raw:: html
-
-   <p align="center">
-    <img src="https://github.com/stanfordnlp/string2string/blob/main/fables/string2string-overview.png" class="center" />
-   </p>
-
-
 The **string2string** library is an open-source tool that offers a comprehensive suite of efficient algorithms for a broad range of string-to-string problems. It includes both traditional algorithmic solutions and recent advanced neural approaches to address various problems in pairwise string alignment, distance measurement, lexical and semantic search, and similarity analysis. Additionally, the library provides several helpful visualization tools and metrics to facilitate the interpretation and analysis of these methods.
 
 The library features notable algorithms such as the `Smith-Waterman algorithm <https://en.wikipedia.org/wiki/Smith%E2%80%93Waterman_algorithm>`_ for pairwise local alignment, the `Hirschberg algorithm <https://en.wikipedia.org/wiki/Hirschberg%27s_algorithm>`_ for global alignment, the `Wagner-Fisher algorithm <https://en.wikipedia.org/wiki/Wagner%E2%80%93Fischer_algorithm>`_ for `edit distance <https://en.wikipedia.org/wiki/Edit_distance>`_, `BARTScore <https://github.com/neulab/BARTScore>`_ and `BERTScore <https://github.com/Tiiiger/bert_score>`_ for similarity analysis, the `Knuth-Morris-Pratt <https://en.wikipedia.org/wiki/Knuth%E2%80%93Morris%E2%80%93Pratt_algorithm>`_ algorithm for lexical search, and `Faiss <https://github.com/facebookresearch/faiss>`_ for `semantic search <https://en.wikipedia.org/wiki/Semantic_search>`_. Moreover, it wraps existing highly efficient and widely-used implementations of certain frameworks and metrics, such as `sacreBLEU <https://github.com/mjpost/sacrebleu>`_ and `ROUGE <https://github.com/google-research/google-research/tree/master/rouge>`_, whenever it is appropriate and suitable.
@@ -65,3 +58,23 @@ Tutorials
 
    hupd_example
    plagiarism_detection
+
+
+Citation
+--------
+
+.. code-block:: bibtex
+
+   @article{suzgun2023string2string,
+      title={string2string: A Modern Python Library for String-to-String Algorithms},
+      author={Suzgun, Mirac and Shieber, Stuart M and Jurafsky, Dan},
+      journal={arXiv preprint arXiv:2304.14395},
+      year={2023}
+   }
+
+
+
+Thanks
+------
+
+Our project owes a debt of gratitude to the following individuals for their contributions, comments, and feedback: Federico Bianchi, Corinna Coupette, Sebastian Gehrmann, Tayfun Gür, Şule Kahraman, Deniz Keleş, Luke Melas-Kyriazi, Christopher Manning, Tolúlopé Ògúnrèmí, Alexander "Sasha" Rush, Kyle Swanson, and Garrett Tanzer.

setup.py

@@ -1,9 +1,14 @@
 from setuptools import find_packages, setup
 
+with open('README.md') as f:
+    readme = f.read()
+
 setup(
     name="string2string",
-    version="0.0.146",
+    version="0.0.150",
     description="String-to-String Algorithms for Natural Language Processing",
+    long_description=readme,
+    long_description_content_type='text/markdown',
     url="https://github.com/stanfordnlp/string2string",
     author="Mirac Suzgun",
     author_email="msuzgun@cs.stanford.edu",