Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 1.78 KB

README.md

File metadata and controls

60 lines (46 loc) · 1.78 KB
Raw

company-ngram

A company backend for N-gram based completion.

This backend produces completion candidates that are fuzzily matching to N-gram data. The N-gram data is automatically constructed from *.txt files placed directly under company-ngram-data-dir directory. If you set company-ngram-n to 4, three words before the cursor are used to produce completion candidates.

To mitigate the data sparsity problem, this backend uses a fuzzy-matching strategy. Given the following sentence, Dear Dr. Aki, , this backend produces completion candidates that match at least one of following prefixes,

Dear Dr. Aki,
*    Dr. Aki,
Dear *   Aki,
*    *   Aki,
Dear Dr. *
*    Dr. *
Dear *   *

where * matches an arbitrary word. Hence, even if your *.txt does not contain the word Aki, you still have chance to get completion candidates.

Configurations

; ~/.emacs.d/init.el

(with-eval-after-load 'company-ngram
  ; ~/data/ngram/*.txt are used as data
  (setq company-ngram-data-dir "~/data/ngram")
  ; company-ngram supports python 3 or newer
  (setq company-ngram-python "python3")
  (company-ngram-init)
  (cons 'company-ngram-backend company-backends)
  ; or use `M-x turn-on-company-ngram' and
  ; `M-x turn-off-company-ngram' on individual buffers
  ;
  ; save the cache of candidates
  (run-with-idle-timer 7200 t
                       (lambda ()
                         (company-ngram-command "save_cache")
                         ))
  )

(require 'company-ngram nil t)

RFC provides handy text files for a quick trial.

wget --directory-prefix ~/data/ngram    https://www.rfc-editor.org/rfc/rfc{5661,6716,4949}.txt

License

The GNU General Public License version 3.