Add Firefox Translations
This commit is contained in:
ModMapper
2919
public/assets/bergamot-translator-worker.js
Normal file
2919
public/assets/bergamot-translator-worker.js
Normal file
File diff suppressed because it is too large
Load Diff
BIN
public/assets/bergamot-translator-worker.wasm
Normal file
BIN
public/assets/bergamot-translator-worker.wasm
Normal file
Binary file not shown.
475
public/assets/translator-worker.js
Normal file
475
public/assets/translator-worker.js
Normal file
@@ -0,0 +1,475 @@
|
||||
/**
|
||||
* Wrapper around the dirty bits of Bergamot's WASM bindings.
|
||||
*/
|
||||
|
||||
// Global because importScripts is global.
|
||||
var Module = {};
|
||||
|
||||
/**
|
||||
* node.js compatibility: Fake GlobalWorkerScope that emulates being inside a
|
||||
* WebWorker
|
||||
*/
|
||||
if (typeof self === 'undefined') {
|
||||
global.Module = Module;
|
||||
|
||||
global.self = new class GlobalWorkerScope {
|
||||
/** @type {import("node:worker_threads").MessagePort} */
|
||||
#port;
|
||||
|
||||
constructor() {
|
||||
const {parentPort} = require(/* webpackIgnore: true */ 'node:worker_threads');
|
||||
this.#port = parentPort;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add event listener to listen for messages posted to the worker.
|
||||
* @param {string} eventName
|
||||
* @param {(object)} callback
|
||||
*/
|
||||
addEventListener(eventName, callback) {
|
||||
this.#port.on(eventName, (data) => callback({data}));
|
||||
}
|
||||
|
||||
/**
|
||||
* Post message outside, to the owner of the Worker.
|
||||
* @param {any} message
|
||||
*/
|
||||
postMessage(message) {
|
||||
this.#port.postMessage(message);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {...string} scripts - Paths to scripts to import in that order
|
||||
*/
|
||||
importScripts(...scripts) {
|
||||
const {readFileSync} = require(/* webpackIgnore: true */ 'node:fs');
|
||||
const {join} = require(/* webpackIgnore: true */ 'node:path');
|
||||
for (let pathname of scripts) {
|
||||
const script = readFileSync(join(__dirname, pathname), {encoding: 'utf-8'});
|
||||
eval.call(global, script);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds support for local file urls. Assumes anything that doesn't start
|
||||
* with "http" to be a local path.
|
||||
* @param {string} url - path or url
|
||||
* @param {object?} options - See `fetch()` options
|
||||
* @return {Promise<Response>}
|
||||
*/
|
||||
async fetch(url, options) {
|
||||
if (url.protocol === 'file:') {
|
||||
const {readFile} = require(/* webpackIgnore: true */ 'node:fs/promises');
|
||||
const buffer = await readFile(url.pathname);
|
||||
const blob = new Blob([buffer]);
|
||||
return new Response(blob, {
|
||||
status: 200,
|
||||
statusText: 'OK',
|
||||
headers: {
|
||||
'Content-Type': 'application/wasm',
|
||||
'Content-Length': blob.size.toString()
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
return await fetch(url, options);
|
||||
}
|
||||
|
||||
get location() {
|
||||
return new URL(`file://${__filename}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
class YAML {
|
||||
/**
|
||||
* Parses YAML into dictionary. Does not interpret types, all values are a
|
||||
* string or a list of strings. No support for objects other than the top
|
||||
* level.
|
||||
* @param {string} yaml
|
||||
* @return {{[string]: string | string[]}}
|
||||
*/
|
||||
static parse(yaml) {
|
||||
const out = {};
|
||||
|
||||
yaml.split('\n').reduce((key, line, i) => {
|
||||
let match;
|
||||
if (match = line.match(/^\s*-\s+(.+?)$/)) {
|
||||
if (!Array.isArray(out[key]))
|
||||
out[key] = out[key].trim() ? [out[key]] : [];
|
||||
out[key].push(match[1].trim());
|
||||
}
|
||||
else if (match = line.match(/^\s*([A-Za-z0-9_][A-Za-z0-9_-]*):\s*(.*)$/)) {
|
||||
key = match[1];
|
||||
out[key] = match[2].trim();
|
||||
}
|
||||
else if (!line.trim()) {
|
||||
// whitespace, ignore
|
||||
}
|
||||
else {
|
||||
throw Error(`Could not parse line ${i+1}: "${line}"`);
|
||||
}
|
||||
return key;
|
||||
}, null);
|
||||
|
||||
return out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Turns an object into a YAML string. No support for objects, only simple
|
||||
* types and lists of simple types.
|
||||
* @param {{[string]: string | number | boolean | string[]}} data
|
||||
* @return {string}
|
||||
*/
|
||||
static stringify(data) {
|
||||
return Object.entries(data).reduce((str, [key, value]) => {
|
||||
let valstr = '';
|
||||
if (Array.isArray(value))
|
||||
valstr = value.map(val => `\n - ${val}`).join('');
|
||||
else if (typeof value === 'number' || typeof value === 'boolean' || value.match(/^\d*(\.\d+)?$/))
|
||||
valstr = `${value}`;
|
||||
else
|
||||
valstr = `${value}`; // Quote?
|
||||
|
||||
return `${str}${key}: ${valstr}\n`;
|
||||
}, '');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Wrapper around the bergamot-translator exported module that hides the need
|
||||
* of working with C++ style data structures and does model management.
|
||||
*/
|
||||
class BergamotTranslatorWorker {
|
||||
/**
|
||||
* Map of expected symbol -> name of fallback symbol for functions that can
|
||||
* be swizzled for a faster implementation. Firefox Nightly makes use of
|
||||
* this.
|
||||
*/
|
||||
static GEMM_TO_FALLBACK_FUNCTIONS_MAP = {
|
||||
'int8_prepare_a': 'int8PrepareAFallback',
|
||||
'int8_prepare_b': 'int8PrepareBFallback',
|
||||
'int8_prepare_b_from_transposed': 'int8PrepareBFromTransposedFallback',
|
||||
'int8_prepare_b_from_quantized_transposed': 'int8PrepareBFromQuantizedTransposedFallback',
|
||||
'int8_prepare_bias': 'int8PrepareBiasFallback',
|
||||
'int8_multiply_and_add_bias': 'int8MultiplyAndAddBiasFallback',
|
||||
'int8_select_columns_of_b': 'int8SelectColumnsOfBFallback'
|
||||
};
|
||||
|
||||
/**
|
||||
* Name of module exported by Firefox Nightly that exports an optimised
|
||||
* implementation of the symbols mentioned above.
|
||||
*/
|
||||
static NATIVE_INT_GEMM = 'mozIntGemm';
|
||||
|
||||
/**
|
||||
* Empty because we can't do async constructors yet. It is the
|
||||
* responsibility of whoever owns this WebWorker to call `initialize()`.
|
||||
*/
|
||||
constructor(options) {}
|
||||
|
||||
/**
|
||||
* Instantiates a new translation worker with optional options object.
|
||||
* If this call succeeds, the WASM runtime is loaded and ready.
|
||||
*
|
||||
* Available options are:
|
||||
* useNativeIntGemm: {true | false} defaults to false. If true, it will
|
||||
* attempt to link to the intgemm module available in
|
||||
* Firefox Nightly which makes translations much faster.
|
||||
* cacheSize: {Number} defaults to 0 which disables translation
|
||||
* cache entirely. Note that this is a theoretical
|
||||
* upper bound. In practice it will use about 1/3th of
|
||||
* the cache specified here. 2^14 is not a bad starting
|
||||
* value.
|
||||
* @param {{useNativeIntGemm: boolean, cacheSize: number}} options
|
||||
*/
|
||||
async initialize(options) {
|
||||
this.options = options || {};
|
||||
this.models = new Map(); // Map<str,Promise<TranslationModel>>
|
||||
this.module = await this.loadModule();
|
||||
this.service = await this.loadTranslationService();
|
||||
}
|
||||
|
||||
/**
|
||||
* Tries to load native IntGEMM module for bergamot-translator. If that
|
||||
* fails because it or any of the expected functions is not available, it
|
||||
* falls back to using the naive implementations that come with the wasm
|
||||
* binary itself through `linkFallbackIntGemm()`.
|
||||
* @param {{env: {memory: WebAssembly.Memory}}} info
|
||||
* @return {{[method:string]: (...any) => any}}
|
||||
*/
|
||||
linkNativeIntGemm(info) {
|
||||
if (!WebAssembly['mozIntGemm']) {
|
||||
console.warn('Native gemm requested but not available, falling back to embedded gemm');
|
||||
return this.linkFallbackIntGemm(info);
|
||||
}
|
||||
|
||||
const instance = new WebAssembly.Instance(WebAssembly['mozIntGemm'](), {
|
||||
'': {memory: info['env']['memory']}
|
||||
});
|
||||
|
||||
if (!Array.from(Object.keys(BergamotTranslatorWorker.GEMM_TO_FALLBACK_FUNCTIONS_MAP)).every(fun => instance.exports[fun])) {
|
||||
console.warn('Native gemm is missing expected functions, falling back to embedded gemm');
|
||||
return this.linkFallbackIntGemm(info);
|
||||
}
|
||||
|
||||
return instance.exports;
|
||||
}
|
||||
|
||||
/**
|
||||
* Links intgemm functions that are already available in the wasm binary,
|
||||
* but just exports them under the name that is expected by
|
||||
* bergamot-translator.
|
||||
* @param {{env: {memory: WebAssembly.Memory}}} info
|
||||
* @return {{[method:string]: (...any) => any}}
|
||||
*/
|
||||
linkFallbackIntGemm(info) {
|
||||
const mapping = Object.entries(BergamotTranslatorWorker.GEMM_TO_FALLBACK_FUNCTIONS_MAP).map(([key, name]) => {
|
||||
return [key, (...args) => Module['asm'][name](...args)]
|
||||
});
|
||||
|
||||
return Object.fromEntries(mapping);
|
||||
}
|
||||
|
||||
/**
|
||||
* Internal method. Reads and instantiates the WASM binary. Returns a
|
||||
* promise for the exported Module object that contains all the classes
|
||||
* and functions exported by bergamot-translator.
|
||||
* @return {Promise<BergamotTranslator>}
|
||||
*/
|
||||
loadModule() {
|
||||
return new Promise(async (resolve, reject) => {
|
||||
try {
|
||||
const response = await self.fetch(new URL('./bergamot-translator-worker.wasm', self.location));
|
||||
|
||||
Object.assign(Module, {
|
||||
instantiateWasm: (info, accept) => {
|
||||
try {
|
||||
WebAssembly.instantiateStreaming(response, {
|
||||
...info,
|
||||
'wasm_gemm': this.options.useNativeIntGemm
|
||||
? this.linkNativeIntGemm(info)
|
||||
: this.linkFallbackIntGemm(info)
|
||||
}).then(({instance}) => accept(instance)).catch(reject);
|
||||
} catch (err) {
|
||||
reject(err);
|
||||
}
|
||||
return {};
|
||||
},
|
||||
onRuntimeInitialized: () => {
|
||||
resolve(Module);
|
||||
}
|
||||
});
|
||||
|
||||
// Emscripten glue code. Webpack et al. should not mangle the `Module` property name!
|
||||
self.Module = Module;
|
||||
self.importScripts('bergamot-translator-worker.js');
|
||||
} catch (err) {
|
||||
reject(err);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Internal method. Instantiates a BlockingService()
|
||||
* @return {BergamotTranslator.BlockingService}
|
||||
*/
|
||||
loadTranslationService() {
|
||||
return new this.module.BlockingService({
|
||||
cacheSize: Math.max(this.options.cacheSize || 0, 0)
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether a model has already been loaded in this worker. Marked
|
||||
* async because the message passing interface we use expects async methods.
|
||||
* @param {{from:string, to:string}}
|
||||
* @return boolean
|
||||
*/
|
||||
hasTranslationModel({from,to}) {
|
||||
const key = JSON.stringify({from,to});
|
||||
return this.models.has(key);
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads a translation model from a set of file buffers. After this, the
|
||||
* model is available to translate with and `hasTranslationModel()` will
|
||||
* return true for this pair.
|
||||
* @param {{from:string, to:string}}
|
||||
* @param {{
|
||||
* model: ArrayBuffer,
|
||||
* shortlist: ArrayBuffer,
|
||||
* vocabs: ArrayBuffer[],
|
||||
* qualityModel: ArrayBuffer?,
|
||||
* config?: {
|
||||
* [key:string]: string
|
||||
* }
|
||||
* }} buffers
|
||||
*/
|
||||
loadTranslationModel({from, to}, buffers) {
|
||||
// This because service_bindings.cpp:prepareVocabsSmartMemories :(
|
||||
const uniqueVocabs = buffers.vocabs.filter((vocab, index, vocabs) => {
|
||||
return !vocabs.slice(0, index).includes(vocab);
|
||||
});
|
||||
|
||||
const [modelMemory, shortlistMemory, qualityModel, ...vocabMemory] = [
|
||||
this.prepareAlignedMemoryFromBuffer(buffers.model, 256),
|
||||
this.prepareAlignedMemoryFromBuffer(buffers.shortlist, 64),
|
||||
buffers.qualityModel // optional quality model
|
||||
? this.prepareAlignedMemoryFromBuffer(buffers.qualityModel, 64)
|
||||
: null,
|
||||
...uniqueVocabs.map(vocab => this.prepareAlignedMemoryFromBuffer(vocab, 64))
|
||||
];
|
||||
|
||||
const vocabs = new this.module.AlignedMemoryList();
|
||||
vocabMemory.forEach(vocab => vocabs.push_back(vocab));
|
||||
|
||||
// Defaults
|
||||
let modelConfig = YAML.parse(`
|
||||
beam-size: 1
|
||||
normalize: 1.0
|
||||
word-penalty: 0
|
||||
cpu-threads: 0
|
||||
gemm-precision: int8shiftAlphaAll
|
||||
skip-cost: true
|
||||
`);
|
||||
|
||||
if (buffers.config)
|
||||
Object.assign(modelConfig, buffers.config);
|
||||
|
||||
// WASM marian is only compiled with support for shiftedAll.
|
||||
if (modelConfig['gemm-precision'] === 'int8')
|
||||
modelConfig['gemm-precision'] = 'int8shiftAll';
|
||||
|
||||
// Override these
|
||||
Object.assign(modelConfig, YAML.parse(`
|
||||
alignment: soft
|
||||
quiet: true
|
||||
quiet-translation: true
|
||||
max-length-break: 128
|
||||
mini-batch-words: 1024
|
||||
workspace: 128
|
||||
max-length-factor: 2.0
|
||||
`));
|
||||
|
||||
const key = JSON.stringify({from,to});
|
||||
this.models.set(key, new this.module.TranslationModel(YAML.stringify(modelConfig), modelMemory, shortlistMemory, vocabs, qualityModel));
|
||||
}
|
||||
|
||||
/**
|
||||
* Frees up memory used by old translation model. Does nothing if model is
|
||||
* already deleted.
|
||||
* @param {{from:string, to:string}}
|
||||
*/
|
||||
freeTranslationModel({from, to}) {
|
||||
const key = JSON.stringify({from,to});
|
||||
|
||||
if (!this.models.has(key))
|
||||
return;
|
||||
|
||||
const model = this.models.get(key);
|
||||
this.models.delete(key);
|
||||
|
||||
model.delete();
|
||||
}
|
||||
|
||||
/**
|
||||
* Internal function. Copies the data from an ArrayBuffer into memory that
|
||||
* can be used inside the WASM vm by Marian.
|
||||
* @param {{ArrayBuffer}} buffer
|
||||
* @param {number} alignmentSize
|
||||
* @return {BergamotTranslator.AlignedMemory}
|
||||
*/
|
||||
prepareAlignedMemoryFromBuffer(buffer, alignmentSize) {
|
||||
const bytes = new Int8Array(buffer);
|
||||
const memory = new this.module.AlignedMemory(bytes.byteLength, alignmentSize);
|
||||
memory.getByteArrayView().set(bytes);
|
||||
return memory;
|
||||
}
|
||||
|
||||
/**
|
||||
* Public. Does actual translation work. You have to make sure that the
|
||||
* models necessary for translating text are already loaded before calling
|
||||
* this method. Returns a promise with translation responses.
|
||||
* @param {{models: {from:string, to:string}[], texts: {text: string, html: boolean}[]}}
|
||||
* @return {Promise<{target: {text: string}}[]>}
|
||||
*/
|
||||
translate({models, texts}) {
|
||||
// Convert texts array into a std::vector<std::string>.
|
||||
let input = new this.module.VectorString();
|
||||
texts.forEach(({text}) => input.push_back(text));
|
||||
|
||||
// Extracts the texts[].html options into ResponseOption objects
|
||||
let options = new this.module.VectorResponseOptions();
|
||||
texts.forEach(({html, qualityScores}) => options.push_back({alignment: false, html, qualityScores}));
|
||||
|
||||
// Turn our model names into a list of TranslationModel pointers
|
||||
const translationModels = models.map(({from,to}) => {
|
||||
const key = JSON.stringify({from,to});
|
||||
return this.models.get(key);
|
||||
});
|
||||
|
||||
// translate the input, which is a vector<String>; the result is a vector<Response>
|
||||
const responses = models.length > 1
|
||||
? this.service.translateViaPivoting(...translationModels, input, options)
|
||||
: this.service.translate(...translationModels, input, options);
|
||||
|
||||
input.delete();
|
||||
options.delete();
|
||||
|
||||
// Convert the Response WASM wrappers into native JavaScript types we
|
||||
// can send over the 'wire' (message passing) in the same format as we
|
||||
// use in bergamot-translator.
|
||||
const translations = texts.map((_, i) => ({
|
||||
target: {
|
||||
text: responses.get(i).getTranslatedText()
|
||||
}
|
||||
}));
|
||||
|
||||
responses.delete();
|
||||
|
||||
return translations;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Because you can't put an Error object in a message. But you can post a
|
||||
* generic object!
|
||||
* @param {Error} error
|
||||
* @return {{
|
||||
* name: string?,
|
||||
* message: string?,
|
||||
* stack: string?
|
||||
* }}
|
||||
*/
|
||||
function cloneError(error) {
|
||||
return {
|
||||
name: error.name,
|
||||
message: error.message,
|
||||
stack: error.stack
|
||||
};
|
||||
}
|
||||
|
||||
// (Constructor doesn't really do anything, we need to call `initialize()`
|
||||
// first before using it. That happens from outside the worker.)
|
||||
const worker = new BergamotTranslatorWorker();
|
||||
|
||||
self.addEventListener('message', async function({data: {id, name, args}}) {
|
||||
if (!id)
|
||||
console.error('Received message without id', arguments[0]);
|
||||
|
||||
try {
|
||||
if (typeof worker[name] !== 'function')
|
||||
throw TypeError(`worker[${name}] is not a function`);
|
||||
|
||||
// Using `Promise.resolve` to await any promises that worker[name]
|
||||
// possibly returns.
|
||||
const result = await Promise.resolve(Reflect.apply(worker[name], worker, args));
|
||||
self.postMessage({id, result});
|
||||
} catch (error) {
|
||||
self.postMessage({
|
||||
id,
|
||||
error: cloneError(error)
|
||||
})
|
||||
}
|
||||
});
|
||||
Reference in New Issue
Block a user