113 lines
4.0 KiB
Markdown
113 lines
4.0 KiB
Markdown
# gse
|
||
|
||
Go efficient text segmentation; support english, chinese, japanese and other.
|
||
|
||
<!--<img align="right" src="https://raw.githubusercontent.com/go-ego/ego/master/logo.jpg">-->
|
||
<!--<a href="https://circleci.com/gh/go-ego/ego/tree/dev"><img src="https://img.shields.io/circleci/project/go-ego/ego/dev.svg" alt="Build Status"></a>-->
|
||
[](https://circleci.com/gh/go-ego/gse)
|
||
[](https://codecov.io/gh/go-ego/gse)
|
||
[](https://travis-ci.org/go-ego/gse)
|
||
[](https://goreportcard.com/report/github.com/go-ego/gse)
|
||
[](https://godoc.org/github.com/go-ego/gse)
|
||
[](https://github.com/go-ego/gse/releases/latest)
|
||
[](https://gitter.im/go-ego/ego?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||
<!--<a href="https://github.com/go-ego/ego/releases"><img src="https://img.shields.io/badge/%20version%20-%206.0.0%20-blue.svg?style=flat-square" alt="Releases"></a>-->
|
||
|
||
[简体中文](https://github.com/go-ego/gse/blob/master/README_zh.md)
|
||
|
||
<a href="https://github.com/go-ego/gse/blob/master/dictionary.go">Dictionary </a> with double array trie (Double-Array Trie) to achieve,
|
||
<a href="https://github.com/go-ego/gse/blob/master/segmenter.go">Sender </a> algorithm is the shortest path based on word frequency plus dynamic programming.
|
||
|
||
Support common and search engine two participle mode, support user dictionary, POS tagging, run<a href="https://github.com/go-ego/gse/blob/master/server/server.go"> JSON RPC service</a>.
|
||
|
||
Text Segmentation speed<a href="https://github.com/go-ego/gse/blob/master/tools/benchmark.go"> single thread</a> 9MB/s，<a href="https://github.com/go-ego/gse/blob/master/tools/goroutines.go">goroutines concurrent</a> 42MB/s (8 nuclear Macbook Pro).
|
||
|
||
## Install / update
|
||
|
||
```
|
||
go get -u github.com/go-ego/gse
|
||
```
|
||
|
||
## [Build-tools](https://github.com/go-ego/re)
|
||
```
|
||
go get -u github.com/go-ego/re
|
||
```
|
||
### re gse
|
||
To create a new gse application
|
||
|
||
```
|
||
$ re gse my-gse
|
||
```
|
||
|
||
### re run
|
||
|
||
To run the application we just created, you can navigate to the application folder and execute:
|
||
```
|
||
$ cd my-gse && re run
|
||
```
|
||
|
||
|
||
## Use
|
||
|
||
|
||
```go
|
||
package main
|
||
|
||
import (
|
||
"fmt"
|
||
|
||
"github.com/go-ego/gse"
|
||
)
|
||
|
||
func main() {
|
||
// Load the dictionary
|
||
var seg gse.Segmenter
|
||
// Loading the default dictionary
|
||
seg.LoadDict()
|
||
// seg.LoadDict("your gopath"+"/src/github.com/go-ego/gse/data/dict/dictionary.txt")
|
||
|
||
// Text Segmentation
|
||
text := []byte("你好世界, Hello world.")
|
||
fmt.Println(segmenter.String(text, true))
|
||
|
||
segments := segmenter.Segment(text)
|
||
|
||
// Handle word segmentation results
|
||
// Support for normal mode and search mode two participle,
|
||
// see the comments in the code ToString function.
|
||
// The search mode is mainly used to provide search engines
|
||
// with as many keywords as possible
|
||
fmt.Println(gse.ToString(segments, true))
|
||
}
|
||
```
|
||
|
||
[Look at an custom dictionary example](/examples/dict/main.go)
|
||
|
||
```Go
|
||
package main
|
||
|
||
import (
|
||
"fmt"
|
||
|
||
"github.com/go-ego/gse"
|
||
)
|
||
|
||
func main() {
|
||
var seg gse.Segmenter
|
||
seg.LoadDict("zh,testdata/test_dict.txt,testdata/test_dict1.txt")
|
||
|
||
text1 := []byte("你好世界, Hello world")
|
||
|
||
segments := seg.Segment(text1)
|
||
fmt.Println(gse.ToString(segments))
|
||
}
|
||
```
|
||
|
||
[Look at an Chinese example](https://github.com/go-ego/gse/blob/master/examples/example.go)
|
||
|
||
[Look at an Japanese example](https://github.com/go-ego/gse/blob/master/examples/jp/main.go)
|
||
|
||
## License
|
||
|
||
Gse is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), base on [sego](https://github.com/huichen/sego).
|