diff --git a/README.md b/README.md index db4271e..65688b1 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,11 @@ A Go implementation of [t-Distributed Stochastic Neighbor Embedding (t-SNE)](htt ### Usage Import this library: ```Go - import "github.com/danaugrs/go-tsne/tsne" +import "github.com/danaugrs/go-tsne/tsne" ``` Create the TSNE object: ```Go - t := tsne.NewTSNE(2, 300, 100, 300, true) +t := tsne.NewTSNE(2, 300, 100, 300, true) ``` The parameters are * Number of output dimensions @@ -25,20 +25,20 @@ The parameters are There are two ways to start the t-SNE embedding optimization. The regular way is to provide an `n` by `d` matrix where each row is a datapoint and each column is a dimension: ```Go - Y := t.EmbedData(X, nil) +Y := t.EmbedData(X, nil) ``` The alternative is to provide a distance matrix directly: ```Go - Y := t.EmbedDistances(D, nil) +Y := t.EmbedDistances(D, nil) ``` In either case, the returned matrix `Y` will contain the final embedding. For more fine-grained control, a step function can be provided in either case: ```Go - Y := t.EmbedData(X, func(iter int, divergence float64, embedding mat.Matrix) bool { - fmt.Printf("Iteration %d: divergence is %v\n", iter, divergence) - return false - }) +Y := t.EmbedData(X, func(iter int, divergence float64, embedding mat.Matrix) bool { + fmt.Printf("Iteration %d: divergence is %v\n", iter, divergence) + return false +}) ``` The step function has access to the iteration, the current divergence, and the embedding optimized so far. You can return `true` to halt the optimization. @@ -47,9 +47,9 @@ You can return `true` to halt the optimization. Two examples are provided - `mnist2d` and `mnist3d`. They both use the same data - a subset of [MNIST](http://yann.lecun.com/exdb/mnist/) with 2500 handwritten digits. `mnist2d` generates plots throughout the optimization process, and `mnist3d` shows the optimization happening in real-time, in 3D. `mnist3d` depends on [G3N](https://github.com/g3n/engine). To run an example, `cd` to the example's directory, build it, and execute it, e.g: ``` - cd examples/mnist2d - go build - ./mnist2d +cd examples/mnist2d +go build +./mnist2d ``` ### Support