Fix the build on MacOS

Three things kept it from building there:

- librt was linked unconditionally, MacOS has those functions in its system
  library and no librt to link
- -march=native and -mtune=native are not accepted by the compilers on Apple
  Silicon. They are dropped there, the speed of the training is not what MacOS
  is used for here
- homebrew installs into /opt/homebrew on Apple Silicon, which was in neither
  the include nor the library path

STATIC_DEREKO2VEC stops with an explanation on MacOS now instead of failing at
link time, as there are no static system libraries to link against.

Verified on Linux that nothing changes: -march=native and -lrt are still used,
the build and the training test pass. The MacOS paths themselves were only
exercised by forcing APPLE, a real build there has not been tried.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Change-Id: I60846a306241901308282c4ae1a3e5b67649d51e
1 file changed
tree: 83844df69763180a54cec6b9c083ea89549b4785
  1. ci/
  2. scripts/
  3. src/
  4. tests/
  5. .gitignore
  6. .gitlab-ci.yml
  7. CMakeLists.txt
  8. LICENSE
  9. README.md
README.md

dereko2vec

Fork of wang2vec with extensions for re-training and count based models, support for tokens with frequencies > 2³² and a more accurate ETA prognosis.

Installation

Dependencies

  • cmake
  • the rocksdb of the distribution, e.g. librocksdb-dev on Debian and Ubuntu or rocksdb-devel on Fedora and Rocky Linux
  • libcollocatordb >= v1.5.0, which builds against that rocksdb

Build and install

cd dereko2vec
mkdir build
cd build
cmake ..
make && ctest --extra-verbose && sudo make install

This installs dereko2vec and vecs2mmap. The build directory has to be build inside the sources, the test looks for the binary relative to it.

A completely static dereko2vec is about 10% faster on the collocator database and needs a static rocksdb and a static collocatordb:

cmake -DSTATIC_DEREKO2VEC=ON ..

Debian and Ubuntu ship librocksdb.a in librocksdb-dev. Fedora, Rocky Linux and RHEL do not, the collocatordb README says how to build one there without shadowing the headers of the package.

Run

The command to build word embeddings is exactly the same as in the original version, except that we added type 5 for setting up a purely count based collocation database.

The -type argument is a integer that defines the architecture to use. These are the possible parameters:
0 - cbow
1 - skipngram
2 - cwindow (see below)
3 - structured skipngram(see below)
4 - collobert's senna context window model (still experimental)
5 - build a collocation count database instead of word embeddings

Example

./dereko2vec -train input_file -output embedding_file -type 0 -size 50 -window 5 -negative 10 -nce 0 -hs 0 -sample 1e-4 -threads 1 -binary 1 -iter 5 -cap 0

Generate dereko2vec training input files from KorAP-XML ZIPs

The KorAP-XML-CoNLL-U tool can be used to generate input files for dereko2vec from KorAP-XML ZIPs using its tokenization and setence boundary information, for example:

korapxml2conllu --word2vec wpd19.zip > wpd19.w2vinput

Retrain existing model with new data

For example:

Retrain Vectors:

dereko2vec -train new.traindata -output new.vecs -save-net new.net -type 3 -size 200 -window 5 -negative 10 -threads 44 -binary 1 -iter 100 -read-vocab old.vocab -read-net old.net

Create new RocksDB:

dereko2vec -train new.traindata -output new.rocksdb -type 5 -window 5 -threads 8 -binary 1 -iter 1 -read-vocab old.vocab -sample 0 -min-count 0
dereko2vec -train new.traindata -output .temp.rocksdb -type 5 -window 5 -threads 8 -binary 1 -iter 1 -save-vocab new_focus.vocab -sample 0 -min-count 0
rm -rf .temp.rocksdb
python scripts/merge_vocabs.py old.vocab new_focus.vocab new.vocab

References

@InProceedings{Ling:2015:naacl,  
author = {Ling, Wang and Dyer, Chris and Black, Alan and Trancoso, Isabel},  
title="Two/Too Simple Adaptations of word2vec for Syntax Problems",  
booktitle="Proceedings of the 2015 Conference of the North American Chapter of the Association for Computational Linguistics: Human Language Technologies",  
year="2015",  
publisher="Association for Computational Linguistics",  
location="Denver, Colorado",  
}

@InProceedings{FankhauserKupietz2019,
author    = {Peter Fankhauser and Marc Kupietz},
title     = {Analyzing domain specific word embeddings for a large corpus of contemporary German},
series = {Proceedings of the 10th International Corpus Linguistics Conference},
publisher = {University of Cardiff},
address   = {Cardiff},
year      = {2019},
note      = {\url{https://doi.org/10.14618/ids-pub-9117}}
}