Fill in README example

ammario · ammario · commit 2bc2f33e6a73 · 2024-05-08T14:28:27.000-05:00
diff --git a/README.md b/README.md
@@ -23,7 +23,19 @@ operations:
 Usage:
 
 ```go
-hnsw.Graph
+g := hnsw.NewGraph[hnsw.Vector]()
+g.Add(
+    hnsw.MakeVector("1", []float32{1, 1, 1}),
+    hnsw.MakeVector("2", []float32{1, -1, 0.999}),
+    hnsw.MakeVector("3", []float32{1, 0, -0.5}),
+)
+
+neighbors := g.Search(
+    []float32{0.5, 0.5, 0.5},
+    1,
+)
+fmt.Printf("best friend: %v\n", neighbors[0].Embedding())
+// Output: best friend: [1 1 1]
 ```
 
 ## Performance
diff --git a/example/readme/main.go b/example/readme/main.go
@@ -10,13 +10,13 @@ func main() {
 	g := hnsw.NewGraph[hnsw.Vector]()
 	g.Add(
 		hnsw.MakeVector("1", []float32{1, 1, 1}),
-		hnsw.MakeVector("2", []float32{1, 0.999, 0.999}),
+		hnsw.MakeVector("2", []float32{1, -1, 0.999}),
 		hnsw.MakeVector("3", []float32{1, 0, -0.5}),
 	)
 
 	neighbors := g.Search(
-		[]float32{1, 1, 1},
+		[]float32{0.5, 0.5, 0.5},
 		1,
 	)
-	fmt.Printf("Neighbors: %v\n", neighbors)
+	fmt.Printf("best friend: %v\n", neighbors[0].Embedding())
 }
diff --git a/graph.go b/graph.go
@@ -344,6 +344,7 @@ func (g *Graph[T]) Add(nodes ...T) {
 	}
 }
 
+// Search finds the k nearest neighbors to the target node.
 func (h *Graph[T]) Search(near Embedding, k int) []T {
 	if len(near) != h.dims {
 		panic(fmt.Sprint("embedding dimension mismatch: ", len(near), " != ", h.dims))

Original file line number	Diff line number	Diff line change
`@@ -10,13 +10,13 @@ func main() {`
`10`	`10`	`g := hnsw.NewGraph[hnsw.Vector]()`
`11`	`11`	`g.Add(`
`12`	`12`	`hnsw.MakeVector("1", []float32{1, 1, 1}),`
`13`		`- hnsw.MakeVector("2", []float32{1, 0.999, 0.999}),`
	`13`	`+ hnsw.MakeVector("2", []float32{1, -1, 0.999}),`
`14`	`14`	`hnsw.MakeVector("3", []float32{1, 0, -0.5}),`
`15`	`15`	`)`
`16`	`16`
`17`	`17`	`neighbors := g.Search(`
`18`		`- []float32{1, 1, 1},`
	`18`	`+ []float32{0.5, 0.5, 0.5},`
`19`	`19`	`1,`
`20`	`20`	`)`
`21`		`- fmt.Printf("Neighbors: %v\n", neighbors)`
	`21`	`+ fmt.Printf("best friend: %v\n", neighbors[0].Embedding())`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -344,6 +344,7 @@ func (g *Graph[T]) Add(nodes ...T) {`
`344`	`344`	`}`
`345`	`345`	`}`
`346`	`346`
	`347`	`+// Search finds the k nearest neighbors to the target node.`
`347`	`348`	`func (h *Graph[T]) Search(near Embedding, k int) []T {`
`348`	`349`	`if len(near) != h.dims {`
`349`	`350`	`panic(fmt.Sprint("embedding dimension mismatch: ", len(near), " != ", h.dims))`