Skip to content
This repository has been archived by the owner on Aug 16, 2021. It is now read-only.

Commit

Permalink
Merge pull request #28 from mathetake/fix/README
Browse files Browse the repository at this point in the history
add license budge and link for the blog post
  • Loading branch information
mathetake authored Jun 8, 2018
2 parents 4dd7264 + 108ec49 commit 1352add
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# gann
[![CircleCI](https://circleci.com/gh/mathetake/gann.svg?style=svg)](https://circleci.com/gh/mathetake/gann)
[![CircleCI](https://circleci.com/gh/mathetake/gann.svg?style=shield&circle-token=9a6608c5baa7a400661a700127778a9ff8baeee3)](https://circleci.com/gh/mathetake/gann)
[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)

gann (go-approximate-nearest-neighbor) is a library for approximate nearest neighbor search purely written in golang.

Expand Down Expand Up @@ -53,18 +54,19 @@ func main() {
```
# interfaces

https://github.com/mathetake/gann/blob/master/gann.go#L32-L36
```golang
type GannIndex interface {
Build() error
GetANNbyItemID(id int64, num int, bucketScale float64) (ann []int64, err error)
GetANNbyVector(v []float32, num int, bucketScale float64) (ann []int64, err error)
GetANNbyItemID(id int64, num int, bucketScale float32) (ann []int64, err error)
GetANNbyVector(v []float32, num int, bucketScale float32) (ann []int64, err error)
}
```

# parameters

To be explained
See the blog post describing the parameters and algorithms in _gann_ :

https://mathetake.github.io/blogs/gann.html

# references

Expand Down

0 comments on commit 1352add

Please sign in to comment.