argostranslate 1.6.1

Offline neural machine translation library and GUI.

Argos Translate

Docs | Website | Video intro | GitHub | Dependencies

Open-source offline translation library written in Python. Uses OpenNMT for translations, SentencePiece for tokenization, Stanza for sentence boundary detection, and PyQt for GUI. Designed to be used as either a Python library, command-line, or GUI application. LibreTranslate is an API and web-app built on top of Argos Translate.

Argos Translate supports installing model files which are a zip archive with an ".argosmodel" extension that contains an OpenNMT CTranslate2 model, a SentencePiece tokenization model, a Stanza tokenizer model for sentence boundary detection, and metadata about the model. Pretrained models can be downloaded here.

Argos Translate also manages automatically pivoting through intermediate languages to translate between languages that don't have a direct translation between them installed. For example, if you have a es ➔ en and en ➔ fr translation installed you are able to translate from es ➔ fr as if you had that translation installed. This allows for translating between a wide variety of languages at the cost of some loss of translation quality.

Models

• Browse models
• P2P download (IPFS and BitTorrent)
• Training script
• Google Drive download

Supported languages

Arabic, Azerbaijani, Chinese, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Irish, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swedish, Turkish, Ukranian, Vietnamese

• Request languages

Screenshots

GUI

Installation

Install from PyPI

Argos Translate is available from PyPI and can be easily installed or updated with pip.

pip3 install argostranslate

Install GUI:

pip3 install argostranslategui

Install from Snap Store

Argos Translate is available from the Snap Store and auto installs a content snap to support translation between Arabic, Chinese, English, French, Russian, and Spanish. Additional languages can be installed from supplementary content snaps.

With snapd installed:

sudo snap install argos-translate

Automatically installs and connects to argos-translate-base-langs snap to support translations between Arabic, Chinese, English, French, Russian, and Spanish.

Additional languages can be installed from *.argosmodel files or from supplementary content snaps:

• argos-translate-de-en - German - English
• argos-translate-en-it - English - Italian
• argos-translate-en-pt - English - Portuguese

To connect automatically: sudo snap connect argos-translate:argos-packages argos-translate-en-it:argos-packages

To run command line interface on Snapcraft:

argos-translate.cli --help

Installation for macOS

1. Download the latest macOS release.
2. Extract the archive.
3. Copy the .app file to the Applications directory.

Python source installation

Dependencies

Requires Python3, pip (which should come with Python3), and optionally virtualenv to keep Argos Translate's dependencies separate from other Python programs you have installed.

Python Installation Instructions

On Ubuntu:

sudo apt-get update
sudo apt-get install -y python3

Install

1. Download a copy of this repo (this requires either installing git or downloading a zip from GitHub):

git clone https://github.com/argosopentech/argos-translate.git
cd argos-translate

2. Make a virtual environment to install into (optional):

python3 -m pip install --upgrade virtualenv # If virtualenv not already installed
virtualenv env
source env/bin/activate

3. Install this package with pip:

python3 -m pip install --upgrade pip
python3 -m pip install .

GPU Acceleration

To enable GPU support, you need to set the ARGOS_DEVICE_TYPE env variable to cuda or auto.

$ ARGOS_DEVICE_TYPE=cuda argos-translate --from-lang en --to-lang es "Hello World"
Hola Mundo

The above env variable instructs CTranslate2 to use cuda. if you encounter any issues with GPU, please consider reading CTranslate2 documentation.

Build and install snap package

1. Install snapd if it isn't already installed.
2. Using snapd install snapcraft and its dependency multipass:

sudo snap install multipass
sudo snap install snapcraft

3. Clone this repo:

git clone https://github.com/argosopentech/argos-translate.git
cd argos-translate

4. From the root directory of this project build the snap package:

SNAPCRAFT_BUILD_ENVIRONMENT_MEMORY=4G snapcraft

Any unzipped package files in package/ will be automatically included in the snap archive (and won't be able to be deleted by users of the snap).

Note, the build won't run with Snapcraft's default build memory of 2GB so you need to set the SNAPCRAFT_BUILD_ENVIRONMENT environment variable. More on Snapcraft forum.

5. Install the snap package:

sudo snap install --devmode argos-translate_<version information>.snap

Run Argos Translate!

GUI

Run the GUI version of Argos Translate.

argos-translate-gui

When installing with snap a .desktop file should also be installed which will make Argos Translate available from the desktop menu.

Languages are chosen as drop down choices. More languages pairs can be installed.

The left text box translates into the right box.

Example workflow translating from Vietnamese into English:

1. Set the left drop down to Vietnamese and the right drop down to English.
2. Replace the default text Text to translate from in the left text box with some text in Vietnamese. A quick way to do this is to click in the left text box and press the keyboard shortcut CTRL+a to select all and then CTRL+v to paste.
3. Wait patiently.
4. When text appears in the right text box, read the translation!

If the output looks similar to the input, try changing the origin language as some languages appear similar if you are unfamiliar with them.

Command Line

Run the command line version of Argos Translate.

argos-translate

Translate a string from English to Spanish.

Note: If you do not have the language pair that you are calling installed, you will get a Traceback error.

argos-translate --from-lang en --to-lang es "Hello World."
Hola Mundo

Translate longer text piped into argos-translate.

echo "Text to translate" | argos-translate --from-lang en --to-lang es
Texto para traducir

Adding language pair models

Language pairs are on average 100MB each.

Installing new pairs through the GUI

1. Open Argos Translate: argos-translate-gui
2. Click on the Manage Packages menu item.
3. Click on the Download packages button.
4. Click on the down arrow beside a language pair that you want to add.
5. Wait for the hourglass icon to change into a check mark icon.
6. Repeat the last two steps until you have all of the language pairs that you want.
7. Click on the X in the top right to close the Download packages window.
8. Click on the X in the top right to close the Manage Packages window.

Note: The Download packages screen does not seem to have a scroll bar so you will probably need to follow the next set of instructions to import new pairs through the GUI.

Importing new pairs through the GUI

1. Download or make new pairs. Model links can be downloaded from this page or this JSON file.
2. Open Argos Translate: argos-translate-gui
3. Click on the Manage Packages menu item.
4. Click on the Install package file button.
5. Navigate to where you downloaded the new language pairs, click on the .argosmodel file, and click on the Open button.
6. Repeat the last two steps until you have all of the language pairs that you want.
7. Click on the X in the top right to close the Manage Packages window.

Importing new pairs through the CLI

1. Update list of available language pairs: argospm update
2. List all available language pairs: argospm search
3. Install new pair syntax: argospm install *lang_pair_name*

For example, install Turkish to English pair: argospm install translate-tr_en

Optionally, you could install all language pairs using BASH.

for i in $(argospm search | sed 's/:.*$//g'); do argospm install $i ; done

Removing a pair through the GUI

1. Open Argos Translate: argos-translate-gui
2. Click on the Manage Packages menu item.
3. Click on the trash can icon besides the pair you want to remove.
4. Click on the X in the top right to close the Manage Packages window.

Removing a pair through the CLI

1. Remove the Turkish to English pair: argospm remove translate-tr_en

Optionally, you could remove all language pairs using BASH if you need to free space fast.

for i in $(argospm list); do argospm remove $i ; done

Examples

Python

from argostranslate import package, translate
package.install_from_path('en_es.argosmodel')
installed_languages = translate.get_installed_languages()

>>> [str(lang) for lang in installed_languages]
>>> ['English', 'Spanish']

translation_en_es = installed_languages[0].get_translation(installed_languages[1])
translation_en_es.translate("Hello World!")

>>> '¡Hola Mundo!'

LibreTranslate Web App (Demo)

LibreTranslate API

const res = await fetch("https://libretranslate.com/translate", {
	method: "POST",
	body: JSON.stringify({
		q: "Hello!",
		source: "en",
		target: "es"
	}),
	headers: {
		"Content-Type": "application/json"}
	});

console.log(await res.json());

{
    "translatedText": "¡Hola!"
}

HTML Translation

The translate-html library is built on top of Argos Translate and Beautiful Soup and parses and translates HTML. The LibreTranslate API also has support for translating HTML.

Files Translation

The argos-translate-files library is built on top of Argos Translate and parses and translates files. The LibreTranslate API also has support for translating files.

Uninstall

If you want to uninstall Argos Translate, you may choose the applicable method.

Uninstall PYPI/pip package

If you installed Argos Translate via pip you can uninstall it using

python3 -m pip uninstall argostranslate

You may choose to also delete temporary and cached files:

rm -r ~/.local/cache/argos-translate
rm -r ~/.local/share/argos-translate

Uninstall Snap

The following command will uninstall the snap package.

sudo snap remove argos-translate argos-translate-base-langs

If you installed additional language packs, you might want to remove them as well, e.g.

sudo snap remove argos-translate-de-en

Contributing

Contributions are welcome! Available issues are on the GitHub issues page.

Support

For support use GitHub Issues, Github Discussions, or the LibreTranslate Forum.

Custom models

Custom models trained on your own data are available for $1000/each (negotiable).

Donations

If you find this software useful donations are appreciated.

• GitHub Sponsor
• PayPal
• Ethereum: 0x4E9017d8e275cA54C91E056381DAb9fe6ECC1AF6
• Bitcoin cash: qzqklgjpgutdqqlhcasmdd2hkqcelw426sxzk5qtne
• Bitcoin: 16UJrmSEGojFPaqjTGpuSMNhNRSsnspFJT
• Filecoin: f1nrnpmjxn27amidyiqrzq5mxihdo2trh2oijw2sq
• Basic Attention Token: 0x8a16f26D277f924B04FCA5ECec64b76B5410A06c
• Cheap Eth: 0x996133E61b81c300a37ACa9b24898685eB872b61

Paid supporters receive priority support.

License

Dual licensed under either the MIT License or CC0.