textdistance

Compute distance between the two texts.

These details have not been verified by PyPI

Project links

Project description

TextDistance logo

TextDistance – python library for compare distance between two or more sequences by many algorithms.

Features:

30+ algorithms
Pure python implementation
Simple usage
More than two sequences comparing
Some algorithms have more than one implementation in one class.
Optional numpy usage for maximum speed.

Algorithms

Edit based

Algorithm	Class	Functions
Hamming	Hamming	hamming
MLIPNS	Mlipns	mlipns
Levenshtein	Levenshtein	levenshtein
Damerau-Levenshtein	DamerauLevenshtein	damerau_levenshtein
Jaro-Winkler	JaroWinkler	jaro_winkler, jaro
Strcmp95	StrCmp95	strcmp95
Needleman-Wunsch	NeedlemanWunsch	needleman_wunsch
Gotoh	Gotoh	gotoh
Smith-Waterman	SmithWaterman	smith_waterman

Token based

Algorithm	Class	Functions
Jaccard index	Jaccard	jaccard
Sørensen–Dice coefficient	Sorensen	sorensen, sorensen_dice, dice
Tversky index	Tversky	tversky
Overlap coefficient	Overlap	overlap
Tanimoto distance	Tanimoto	tanimoto
Cosine similarity	Cosine	cosine
Monge-Elkan	MongeElkan	monge_elkan
Bag distance	Bag	bag

Sequence based

Algorithm	Class	Functions
longest common subsequence similarity	LCSSeq	lcsseq
longest common substring similarity	LCSStr	lcsstr
Ratcliff-Obershelp similarity	RatcliffObershelp	ratcliff_obershelp

Compression based

Work in progress. Now all algorithms compare two strings as array of bits, not by chars.

NCD - normalized compression distance.

Functions:

bz2_ncd
lzma_ncd
arith_ncd
rle_ncd
bwtrle_ncd
zlib_ncd

Phonetic

Algorithm	Class	Functions
MRA	MRA	mra
Editex	Editex	editex

Simple

Algorithm	Class	Functions
Prefix similarity	Prefix	prefix
Postfix similarity	Postfix	postfix
Length distance	Length	length
Identity similarity	Identity	identity
Matrix similarity	Matrix	matrix

Installation

Stable:

pip install textdistance

Dev:

pip install -e git+https://github.com/orsinium/textdistance.git#egg=textdistance

Usage

All algorithms have 2 interfaces:

Class with algorithm-specific params for customizing.
Class instance with default params for quick and simple usage.

All algorithms have some common methods:

.distance(*sequences) – calculate distance between sequences.
.similarity(*sequences) – calculate similarity for sequences.
.maximum(*sequences) – maximum possible value for distance and similarity. For any sequence: distance + similarity == maximum.
.normalized_distance(*sequences) – normalized distance between sequences. The return value is a float between 0 and 1, where 0 means equal, and 1 totally different.
.normalized_similarity(*sequences) – normalized similarity for sequences. The return value is a float between 0 and 1, where 0 means totally different, and 1 equal.

Most common init arguments:

qval – q-value for split sequences into q-grams. Possible values:
- 1 (default) – compare sequences by chars.
- 2 or more – transform sequences to q-grams.
- None – split sequences by words.
as_set – for token-based algorithms:
- True – t and ttt is equal.
- False (default) – t and ttt is different.

Example

For example, Hamming distance:

import textdistance

textdistance.hamming('test', 'text')
# 1

textdistance.hamming.distance('test', 'text')
# 1

textdistance.hamming.similarity('test', 'text')
# 3

textdistance.hamming.normalized_distance('test', 'text')
# 0.25

textdistance.hamming.normalized_similarity('test', 'text')
# 0.75

textdistance.Hamming(qval=2).distance('test', 'text')
# 2

Any other algorithms have same interface.

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

4.6.3

Jul 16, 2024

4.6.2

Apr 24, 2024

4.6.1

Dec 29, 2023

4.6.0

Sep 28, 2023

4.5.0

Sep 18, 2022

4.4.0

Aug 21, 2022

4.3.0

Jun 29, 2022

4.2.2

Oct 27, 2021

4.2.1

Jan 29, 2021

4.2.0

Apr 13, 2020

4.1.5

Oct 3, 2019

4.1.4

Aug 6, 2019

4.1.3

Apr 18, 2019

4.1.2

Mar 18, 2019

4.1.1

Mar 15, 2019

4.1.0

Mar 9, 2019

4.0.0

Mar 3, 2019

3.1.0

Jan 22, 2019

3.0.3

Apr 3, 2018

3.0.2

Mar 31, 2018

3.0.1

Mar 31, 2018

3.0.0

Mar 31, 2018

2.0.5

Apr 3, 2018

2.0.4

Apr 3, 2018

This version

2.0.3

Mar 28, 2018

2.0.1

Feb 10, 2018

2.0.0

Feb 10, 2018

1.0.0

May 5, 2017

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

textdistance-2.0.3.tar.gz (20.9 kB view details)

Uploaded Mar 28, 2018 Source

File details

Details for the file textdistance-2.0.3.tar.gz.

File metadata

Download URL: textdistance-2.0.3.tar.gz
Upload date: Mar 28, 2018
Size: 20.9 kB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for textdistance-2.0.3.tar.gz
Algorithm	Hash digest
SHA256	`9e754ea4e53bdad5ca2a96ed7617bfe3720d62927433afa7737c732a0d0162d0`
MD5	`33303480a34af9fbe32a25640ca0f495`
BLAKE2b-256	`3e88e1413e702416d6b09e0bf6f5d20d941065e2ce9ee9de678cd2ae66a8da2f`