Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
cipepser committed Apr 5, 2018
1 parent e809a66 commit f5228e5
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,42 @@

goClustering is an implementation of following clustering algorithm in Golang.

## Ward's method
## Ward's method

Ward's method is a distance criterion in hierarchical cluster algorithm.
This method put two groups into one to minimize the total within-cluster variance. For detail, see [here](https://en.wikipedia.org/wiki/Ward%27s_method).

## How to Install

You can get goClustering by using go get:

```sh
go get github.com/cipepser/goClustering/...
```

## Example

```go
package main

import (
"fmt"

"github.com/cipepser/goClustering/ward"
)

func main() {
X := [][]float64{
{0, 0},
{1, 0},
{5, 0},
}

T := ward.Ward(X)

fmt.Println(T)
}
```

## References
* [Ward's method](https://en.wikipedia.org/wiki/Ward%27s_method)

0 comments on commit f5228e5

Please sign in to comment.