Jellyfish

https://jamesturk.github.io/jellyfish/
Admin
Jellyfish is a library for approximate and phonetic matching of strings, offering algorithms like...
Tokens:1,617
Snippets:29
Trust Score:8.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Importing Jellyfish Implementations

Source: https://jamesturk.github.io/jellyfish

Import specific Rust or Python implementations of the jellyfish library. The Rust implementation is preferred.

```python
import jellyfish._jellyfish as pyjellyfish
import jellyfish.rustyfish as rustyfish
```

--------------------------------

### Checking Jellyfish Library Implementation

Source: https://jamesturk.github.io/jellyfish

Check which implementation of the jellyfish library is currently being used. This is useful if you have imported jellyfish without specifying an implementation.

```python
if jellyfish.library == 'Python':
    # Python implementation
elif jellyfish.library == 'Rust':
    # Rust implementation
```

--------------------------------

### Compare using Match Rating Approach

Source: https://jamesturk.github.io/jellyfish/functions

Compares two strings using the Match Rating Approach algorithm, returning True if they are considered equivalent, False if not, or None if they are not comparable due to significant length differences (more than 3 characters).

```python
def match_rating_comparison(s1, s2)


```

--------------------------------

### Phonetic Encoding with Soundex

Source: https://jamesturk.github.io/jellyfish

Generate the Soundex phonetic encoding for a given string. Soundex is a phonetic algorithm for indexing names by sound, as pronounced in English.

```python
import jellyfish
jellyfish.soundex('Jellyfish')
```

--------------------------------

### Phonetic Encoding with NYSIIS

Source: https://jamesturk.github.io/jellyfish

Generate the NYSIIS (New York State Identification and Intelligence System) phonetic encoding for a given string. This algorithm is an improvement over Soundex.

```python
import jellyfish
jellyfish.nysiis('Jellyfish')
```

--------------------------------

### Calculating Jaro Similarity

Source: https://jamesturk.github.io/jellyfish

Calculate the Jaro similarity between two strings. This metric quantifies the similarity between two sequences, with a higher score indicating greater similarity.

```python
import jellyfish
jellyfish.jaro_similarity('jellyfish', 'smellyfish')
```

--------------------------------

### Calculate American Soundex

Source: https://jamesturk.github.io/jellyfish/functions

Calculates the American Soundex code for a given string. Soundex is used to encode names into a four-digit code representing pronunciation, useful for matching similar-sounding names.

```python
def soundex(s: str)
```

--------------------------------

### Phonetic Encoding with Metaphone

Source: https://jamesturk.github.io/jellyfish

Generate the Metaphone phonetic encoding for a given string. Metaphone is an algorithm for indexing words by their English pronunciation.

```python
import jellyfish
jellyfish.metaphone('Jellyfish')
```

--------------------------------

### Calculate Match Rating Codex

Source: https://jamesturk.github.io/jellyfish/functions

Calculates the Match Rating Approach (PNI) value for a string. This algorithm is used to determine if two names are pronounced similarly, involving an encoding function and a comparison function.

```python
def match_rating_codex(s: str)
```

--------------------------------

### Phonetic Encoding with Match Rating Codex

Source: https://jamesturk.github.io/jellyfish

Generate the Match Rating Codex phonetic encoding for a given string. This is part of the Match Rating Approach for string comparison.

```python
import jellyfish
jellyfish.match_rating_codex('Jellyfish')
```

--------------------------------

### Compute Jaro-Winkler Similarity

Source: https://jamesturk.github.io/jellyfish/functions

Computes the Jaro-Winkler similarity, an improvement on Jaro similarity that gives more favorable ratings to strings that match from the beginning. It returns a float between 0 and 1.

```python
def jaro_winkler_similarity(s1: str, s2: str)


```

--------------------------------

### Calculate NYSIIS Code

Source: https://jamesturk.github.io/jellyfish/functions

Calculates the NYSIIS (New York State Identification and Intelligence System) code for a given string. This algorithm is primarily intended for phonetic encoding of English names.

```python
def nysiis(s: str)
```

--------------------------------

### Calculate Metaphone Code

Source: https://jamesturk.github.io/jellyfish/functions

Calculates the Metaphone code for a given string. Metaphone is an improvement over Soundex, transforming words into a phonetic code consisting of specific consonants and '0' for 'th'.

```python
def metaphone(s: str)
```

--------------------------------

### Compute Hamming Distance

Source: https://jamesturk.github.io/jellyfish/functions

Calculates the Hamming distance between two strings, measuring the number of positions at which the corresponding characters are different. This implementation considers extra characters in longer strings as differences.

```python
def hamming_distance(s1: str, s2: str)


```

--------------------------------

### Calculating Damerau-Levenshtein Distance

Source: https://jamesturk.github.io/jellyfish

Calculate the Damerau-Levenshtein distance between two strings. This is similar to Levenshtein distance but also accounts for transpositions of adjacent characters.

```python
import jellyfish
jellyfish.damerau_levenshtein_distance('jellyfish', 'jellyfihs')
```

--------------------------------

### Calculating Levenshtein Distance

Source: https://jamesturk.github.io/jellyfish

Calculate the Levenshtein distance between two strings. This measures the minimum number of single-character edits (insertions, deletions, or substitutions) required to change one word into the other.

```python
import jellyfish
jellyfish.levenshtein_distance('jellyfish', 'smellyfish')
```
Tokens:
Raw