Skip to content

Commit 3e8d770

Browse files
committed
QED -- v0.0.150
1 parent 437f1dd commit 3e8d770

File tree

3 files changed

+29
-11
lines changed

3 files changed

+29
-11
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![PyPI version](https://badge.fury.io/py/string2string.svg)](https://badge.fury.io/py/string2string)
99
[![Downloads](https://pepy.tech/badge/string2string)](https://pepy.tech/project/string2string)
1010
[![license](https://img.shields.io/github/license/stanfordnlp/string2string.svg)](https://github.com/stanfordnlp/string2string/blob/main/LICENSE.txt)
11-
[![arXiv](https://img.shields.io/badge/arXiv-2211.07634-b31b1b.svg)](https://arxiv.org/abs/2211.07634)
11+
[![arXiv](https://img.shields.io/badge/arXiv-2304.14395-b31b1b.svg)](https://arxiv.org/abs/2304.14395)
1212

1313
## Table of Contents
1414

@@ -333,14 +333,14 @@ This code snippet shows how to utilize the BARTScore and BERTScore metrics to co
333333
@article{suzgun2023string2string,
334334
title={string2string: A Modern Python Library for String-to-String Algorithms},
335335
author={Suzgun, Mirac and Shieber, Stuart M and Jurafsky, Dan},
336-
journal={arXiv preprint arXiv:[TBD].[TBD]},
336+
journal={arXiv preprint arXiv:2304.14395},
337337
year={2023}
338338
}
339339
```
340340

341341
## Thanks
342342

343-
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.
343+
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.
344344

345345
## Contributing
346346

docs/index.rst

+20-7
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,6 @@
66
Welcome to string2string's documentation!
77
=========================================
88

9-
.. raw:: html
10-
11-
<p align="center">
12-
<img src="https://github.com/stanfordnlp/string2string/blob/main/fables/string2string-overview.png" class="center" />
13-
</p>
14-
15-
169
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.
1710

1811
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
6558

6659
hupd_example
6760
plagiarism_detection
61+
62+
63+
Citation
64+
--------
65+
66+
.. code-block:: bibtex
67+
68+
@article{suzgun2023string2string,
69+
title={string2string: A Modern Python Library for String-to-String Algorithms},
70+
author={Suzgun, Mirac and Shieber, Stuart M and Jurafsky, Dan},
71+
journal={arXiv preprint arXiv:2304.14395},
72+
year={2023}
73+
}
74+
75+
76+
77+
Thanks
78+
------
79+
80+
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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
from setuptools import find_packages, setup
22

3+
with open('README.md') as f:
4+
readme = f.read()
5+
36
setup(
47
name="string2string",
5-
version="0.0.146",
8+
version="0.0.150",
69
description="String-to-String Algorithms for Natural Language Processing",
10+
long_description=readme,
11+
long_description_content_type='text/markdown',
712
url="https://github.com/stanfordnlp/string2string",
813
author="Mirac Suzgun",
914
author_email="[email protected]",

0 commit comments

Comments
 (0)