https://github.com/suggest-go/suggest

Top-k Approximate String Matching.
https://github.com/suggest-go/suggest

autocomplete fuzzy-search fuzzy-string-matching golang-library language-model ngram search-engine spellchecker top-k-approximate-string-matching

Last synced: 14 days ago
JSON representation

Top-k Approximate String Matching.

• Host: GitHub
• URL: https://github.com/suggest-go/suggest
• Owner: suggest-go
• License: mit
• Created: 2017-02-04T02:44:30.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-12-16T15:49:03.000Z (almost 3 years ago)
• Last Synced: 2024-06-19T01:57:44.443Z (6 months ago)
• Topics: autocomplete, fuzzy-search, fuzzy-string-matching, golang-library, language-model, ngram, search-engine, spellchecker, top-k-approximate-string-matching
• Language: Go
• Homepage: https://suggest-go.github.io/
• Size: 34.1 MB
• Stars: 65
• Watchers: 9
• Forks: 4
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome - suggest-go/suggest - Top-k Approximate String Matching. (Go)
• awesome - suggest-go/suggest - Top-k Approximate String Matching. (Go)

README

        
# Suggest

Library for Top-k Approximate String Matching, autocomplete and spell checking.

[![Build Status](https://travis-ci.com/suggest-go/suggest.svg?branch=master)](https://travis-ci.com/suggest-go/suggest)

[![Go Report Card](https://goreportcard.com/badge/github.com/suggest-go/suggest)](https://goreportcard.com/report/github.com/suggest-go/suggest)

[![GoDoc](https://godoc.org/github.com/suggest-go/suggest?status.svg)](https://godoc.org/github.com/suggest-go/suggest)

The library was mostly inspired by

- http://www.chokkan.org/software/simstring/

- http://www.aaai.org/ocs/index.php/AAAI/AAAI10/paper/viewFile/1939/2234

- http://nlp.stanford.edu/IR-book/

- http://bazhenov.me/blog/2012/08/04/autocomplete.html

- http://www.aclweb.org/anthology/C10-1096

## Docs

See the [documentation](https://suggest-go.github.io/) with examples demo and API documentation.

## Demo

#### Fuzzy string search in a dictionary

The [demo](https://suggest-go.github.io/docs/demo/suggest-cars.html) shows an approximate string search in a vehicle dictionary with more than 2k model names.

You can also run it locally

```

$ make build

$ ./build/suggest eval -c pkg/suggest/testdata/config.json -d cars -s 0.5 -k 5

```

or by using Docker

```

$ make build-docker

$ docker run -p 8080:8080 -v $(pwd)/pkg/suggest/testdata:/data/testdata suggest /data/build/suggest service-run -c /data/testdata/config.json

```

![Suggest eval Demo](suggest-eval.gif)

#### Spellchecker

Spellchecker recognizes a misspelled word based on the context of the surrounding words.

In order to run a spellchecker [demo](https://suggest-go.github.io/docs/demo/spellchecker.html), please do the next

* Download an English [language model](https://app.box.com/s/ze53gtxetnqkj5pln7aogge1xo2ca3s0) built on [Blog Authorship Corpus](http://u.cs.biu.ac.il/~koppel/BlogCorpus.htm)

* Extract downloaded language model and perform

```

$ make build

$ ./build/./spellchecker eval -c lm-folder/config.json

```

![Spellchecker eval Demo](spellchecker-eval.gif)

## Contributions

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.