File: README.md

package info (click to toggle)
phosh-osk-data 0.53.0-1
  • links: PTS, VCS
  • area: contrib
  • in suites: sid
  • size: 120 kB
  • sloc: python: 291; makefile: 23
file content (69 lines) | stat: -rw-r--r-- 2,144 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# phosh osk data

Scripts to build word prediction data for [phosh-osk-stevia][] (formerly
known as phosh-osk-stub) and other presage based completers. The aim here is to
have models that are distributable without licensing issues and using modern
language so we're using Wikipedia dumps.

## Building your own dictionaries based in Wikipedia data

Get a host with disk space (~40G), more cores make the first steps
(extraction and parsing into sentences significantly faster.

You can then provision it with the provided ansible playbook on your
cloud provider of choice:

```sh
   ansible-playbook -v -i "${BUILDER}", -u root  builder/setup.yml
```

`${BUILDER}` is the IP or hostname of the host to provision.

Once there get the Wikipedia dump:

```sh
ssh ${BUILDER}
mkdir output/
cd output/
export LANG=es
wget "https://dumps.wikimedia.org/${LANG}wiki/latest/${LANG}wiki-latest-pages-articles.xml.bz2"
```

Import some nltk data:

```sh
python3 -c "import nltk; nltk.download('punkt')"
```

Process the dump

```sh
./pod-db-from-wiki-dump --processes "$(nproc)" --language "${LANG}" --dump "output/${LANG}wiki-latest-pages-articles.xml.bz2" --output  "output/${LANG}"
```

You'll then get a database usable by presage based completers in `output/${LANG}/database_${LANG}.db`.

This happens in steps so should a step fail you can skip it in subsequent runs.
See the `--skip-*` options. The extract and parsing steps happen in parallel
and can be spread over multiple cores (default `8`).

## Installing the data

See the [phosh-data-packager manpage](doc/phosh-osk-data-packager.rst).

## Available Languages

For a list of available languages see <https://data.phosh.mobi/osk-data/latest/presage/>.

## Related projects

- presage: <http://presage.sourceforge.net/>
- sfos presage databases: <https://github.com/sailfish-keyboard/presage-database>
- stevia on screen keyboard: <https://gitlab.gnome.org/World/Phosh/stevia>

## Getting in Touch

- Issue tracker: <https://gitlab.gnome.org/World/Phosh/phosh-osk-data/issues/>
- Matrix: <https://matrix.to/#/#phosh:phosh.mobi>

[phosh-osk-stevia]: https://gitlab.gnome.org/World/Phosh/stevia