mirror of https://github.com/browsermt/bergamot-translator.git synced 2024-08-16 09:00:31 +03:00

History

Nikolay Bogoychev 534ed37a3d Remove wormhole references (#459 ) * Remove warmhole references * Remove more references to the WORMHOLE * Update marian to wormhole removed marian * Whoops --------- Co-authored-by: Jelmer van der Linde <jelmer@ikhoefgeen.nl>		2023-08-14 15:22:54 +01:00
..
bindings	Enables model ensembles (#450 )	2023-08-01 19:35:11 +01:00
module	More portable WASM demo (#437 )	2023-01-18 19:41:39 +00:00
test_page	More portable WASM demo (#437 )	2023-01-18 19:41:39 +00:00
CMakeLists.txt	Upgrade emsdk to 3.1.8 (#414 )	2022-04-20 00:39:32 +01:00
import-gemm-module.js	JS/WASM: Re-enable importing optimized gemm module for (#336 )	2022-02-07 16:55:31 +01:00
node-test.js	Expand the node-test.js example code with documentation (#434 )	2023-01-18 19:09:47 +00:00
patch-artifacts-import-gemm-module.sh	Import optimized gemm implementation (when available) for wasm target (#265 )	2021-11-17 09:18:55 +01:00
project_version.js.in	Modified wasm cmake file to include version information in built artifacts	2021-05-17 19:34:58 +02:00
README.md	Remove wormhole references (#459 )	2023-08-14 15:22:54 +01:00

README.md

Using Bergamot Translator in JavaScript

All the instructions below are meant to run from the current directory.

Using JS APIs

See node-test.js for an annotated example of how to use the WASM module. Most of the code from it can also be used in a browser context.

Alternatively refer to the file test_page/js/worker.js that demonstrates how to use the bergamot translator in JavaScript via a <script> tag.

Demo

Download bergamot model files required for translation

Use following instructions to download model files (make sure that git-lfs is installed and initialized before running these instructions):

cd test_page
git clone --depth 1 --branch main --single-branch https://github.com/mozilla/firefox-translations-models/
mkdir models
cp -rf firefox-translations-models/registry.json models
cp -rf firefox-translations-models/models/prod/* models
cp -rf firefox-translations-models/models/dev/* models
gunzip models/*/*

Start the test webserver (ensure you have the latest nodejs installed)
```
cd test_page
bash start_server.sh ../../build-wasm
```
Provide the folder containing the wasm artifacts as the first argument of start_server.sh script (../../build-wasm in this case).
Open any browser (tested with latest Chrome/Firefox/Safari)
Browse to the following page:
```
http://localhost:80
```
Perform translations:
- Choose the source and target languages using From and To dropdowns.
- Type a sentence to be translated in the From textbox.
- See the result in the To textbox.