.github/workflows | ||
3rd_party | ||
app | ||
doc | ||
docker | ||
src | ||
wasm | ||
.gitignore | ||
.gitmodules | ||
CMakeLists.txt | ||
LICENSE | ||
README.md |
Bergamot Translator
Bergamot translator provides a unified API for (Marian NMT framework based) neural machine translation functionality in accordance with the Bergamot project that focuses on improving client-side machine translation in a web browser.
Build Instructions
Build Natively
git clone --recursive https://github.com/browsermt/bergamot-translator
cd bergamot-translator
mkdir build
cd build
cmake ../
make -j
Build WASM
To compile WASM, first download and Install Emscripten using following instructions:
- Get the latest sdk:
git clone https://github.com/emscripten-core/emsdk.git
- Enter the cloned directory:
cd emsdk
- Install the lastest sdk tools:
./emsdk install latest
- Activate the latest sdk tools:
./emsdk activate latest
- Activate path variables:
source ./emsdk_env.sh
After the successful installation of Emscripten, perform these steps:
git clone --recursive https://github.com/browsermt/bergamot-translator
cd bergamot-translator
git checkout wasm-integration
git submodule update --recursive
mkdir build-wasm
cd build-wasm
emcmake cmake -DCOMPILE_WASM=on ../
emmake make -j
It should generate the artefacts (.js and .wasm files) in wasm
folder inside build directory ("build-wasm" in this case).
Download the models from https://github.com/mozilla-applied-ml/bergamot-models
, and place all the desired ones to package in a folder called models
.
The build also allows packaging files into wasm binary (i.e. preloading in Emscripten’s virtual file system) using cmake
option PACKAGE_DIR
. The compile command below packages all the files in PATH directory (in these case, your models) into wasm binary.
emcmake cmake -DCOMPILE_WASM=on -DPACKAGE_DIR=/repo/models ../
Files packaged this way are preloaded in the root of the virtual file system.
To package the set of files expected by the test page:
mkdir models
git clone https://github.com/motin/bergamot-models
cp -r bergamot-models/* models
gunzip models/*/*
After Editing Files:
emmake make -j
After Adding/Removing Files:
emcmake cmake -DCOMPILE_WASM=on ../
emmake make -j
Using Native version
The builds generate library that can be integrated to any project. All the public header files are specified in src
folder. A short example of how to use the APIs is provided in app/main.cpp
file
Using WASM version
Please follow the README
inside the wasm
folder of this repository that demonstrates how to use the translator in JavaScript.