Skip to content
/ cld2 Public
forked from klauspost/cld2

Latest commit

 

History

History
83 lines (55 loc) · 2.23 KB

README.md

File metadata and controls

83 lines (55 loc) · 2.23 KB

cld2

Build Status

Package cld2 implements language detection using the Compact Language Detector.

This package includes the relevant sources from the cld2 project, so it doesn't require any external dependencies. For more information about CLD2, see https://code.google.com/p/cld2/.

Installation

go get -u github.com/Vivino/cld2

On Linux and Go 1.8+ this is also required:

go generate github.com/Vivino/cld2

Usage

func Detect

func Detect(text string) string

Detect returns the language code for detected language in the given text.

func DetectLang

func DetectLang(text string) Language {

DetectLang returns the Language type for detected language in the given text.

func DetectThree

func DetectThree(text string) Languages

DetectThree returns up to three language guesses.

// Languages are probable languages of the supplied text
type Languages struct {
	Estimates []Estimate // Possible languages returned in order of confidence
	TextBytes int        // the amount of non-tag/letters-only text found
	Reliable  bool       // Does CLD2 see the result as reliable?
}

// Single Language estimate
type Estimate struct {
	Language Language
	Percent  int // text percentage 0..100 of the top 3 languages.

	// NormScore is internal language scores as a ratio to normal score for real text in that language.
	// Scores close to 1.0 indicate normal text, while scores far away
	// from 1.0 indicate badly-skewed text or gibberish.
	NormScore float64
}

cgo

You can compile the package without cgo. It will return "Unknown Language" for all requests.

The package level "Enabled" boolean can be checked to see if everything is expected to work.

Go 1.8+ plugin (Linux)

This will use plugins on linux/amd64 to reduce compilation times.

To recompile this, run go generate in this directory (cld2).

On startup the package will attempt to load the plugin from /lib, ./lib, ., $GOPATH$/src/github.com/Vivino/cld2/lib (where it is provided). To specify a custom path, use cld2.LoadPlugin("/some/path").

go generate github.com/Vivino/cld2 must be used to recompile plugin.