base on CPU-optimized Neural Machine Translation models for Firefox Translations # Firefox Translations models CPU-optimized NMT models for Firefox Translations. The model files are hosted using [Git LFS](https://docs.github.com/en/github/managing-large-files/versioning-large-files/about-git-large-file-storage). [prod](models/prod) - higher quality models [dev](models/dev) - test models under development (can be of low quality or speed). When a dev model has satisfactory quality, it is moved to prod. # Automatic quality evaluation [BLEU scores](evaluation/bleu-results.md), [COMET scores](evaluation/comet-results.md) The evaluation is run as part of a pull request in CI. The PR should include the models in the `models/dev` or `models/prod` category. The evaluation will automatically run, and then commits will be added to the pull request. The evaluation uses Microsoft and Google translation APIs, Argos Translate, NLLB and Opus-MT models and pushes results back to the branch (not available for forks). It is performed using the [evals](/evals) tool. # Model training Use [Firefox Translations training pipeline](https://github.com/mozilla/firefox-translations-training) or [browsermt/students](https://github.com/browsermt/students/tree/master/train-student) recipe to train CPU-optimized models. They should have similar size and inference speed to already submitted models. ## Training data Do not use [SacreBLEU](https://github.com/mjpost/sacrebleu) or [Flores](https://github.com/facebookresearch/flores) datasets as a part of training data, otherwise evaluation will not be correct. To see SacreBLEU datasets run `sacrebleu --list`. # Model contribution All models should be contributed to `dev` folder first. ## Maintainers adding models Create a pull request to the `main` branch from another branch in this repo (not a fork). This pull request should include the models, and the evaluation will be added as extra commits in the CI task. ## Contributors adding models Create a pull request to the `contrib` branch. When it is reviewed and merged, a maintainer should create a pull request from `contrib` to `main`. This second PR will run the automatic evaluation and add the evaluation commits. ## Local testing You can run model evaluation locally by running `bash scripts/update-results.sh`. Make sure to set environment variables `GCP_CREDS_PATH` and `AZURE_TRANSLATOR_KEY` to use Google and Microsoft APIs. If you want to run it with `bergamot` only, remove mentions of those variables from `bash scripts/update-results.sh` and remove `microsoft,google` from `scripts/eval.sh`. # Model types ## Vocabulary Prefix of the vocabulary file in the model registry: - `vocab.` - vocabulary is reused for the source and target languages - `srcvocab.` and `trgvocab.` - different vocabularies for the source and target languages ## GEMM precision Suffix of the model file in the registry: - `intgemm8.bin` - supports `gemm-precision: int8shiftAll` inference setting - `intgemm.alphas.bin` - supports `gemm-precision: int8shiftAlphaAll` inference setting # Downloading a model from Taskcluster Example: ``` cd scripts SRC=lt TRG=en TASK_ID=SjPZGW9CRYeb9PQr68jCUw bash pull_models.sh ``` Where `TASK_ID` is a Taskcluster ID of the `export` task. # Model deployment Models are deployed to Remote Settings to be delivered to Firefox. Records and attachments are uploaded via a CLI tool which lives in the `remote_settings` directory in this repository. View the `remote_settings` [README](https://github.com/mozilla/firefox-translations-models/blob/main/remote_settings/README.md) for more details on publishing models. # Currently supported Languages Prod models are available in all Firefox channels including Release. Dev models are available in Nightly only. ## Prod - Arabic <-> English - Bulgarian <-> English - Catalan <-> English - Chinese (Simplified) <-> English - Croatian -> English - Czech <-> English - Danish <-> English - Dutch <-> English - Estonian <-> English - Finnish <-> English - French <-> English - German <-> English - Greek <-> English - Hungarian <-> English - Indonesian <-> English - Italian <-> English - Japanese <-> English - Korean <-> English - Latvian (Lettish) -> English - Lithuanian -> English - Polish <-> English - Portuguese <-> English - Romanian <-> English - Russian <-> English - Serbian -> English - Slovak -> English - Slovenian <-> English - Spanish <-> English - Swedish <-> English - Turkish <-> English - Ukrainian -> English - Vietnamese -> English ## Dev - Bosnian -> English - Croatian <- English - Icelandic -> English - Latvian (Lettish) <- English - Maltese -> English - Norwegian Bokmål -> English - Norwegian Nynorsk -> English - Persian (Farsi) <-> English - Slovak <- English - Ukrainian <- English ", Assign "at most 3 tags" to the expected json: {"id":"13201","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"