node-EasyNMT

multi-language translate using UKPLab/EasyNMT

Remark: For the server side, you need to have docker installed and available in the PATH. Also, your current user should have the privilege to run docker cli.

Usage (browser)

<script src="https://cdn.jsdelivr.net/npm/node-easynmt@1/bundle.js"></script>
<script>
  console.log(easyNMT)
  /*
  {
    translate,
    patchedTranslate,
    clearCache,
    preloadModel,
  }
  */
</script>

Usage (nodejs)

Installation

npm i node-easynmt

run server:

import { autoStartServer } from 'node-easynmt/server'

// start a docker container if not already running
autoStartServer({ port: 24080 })
  .then(() => console.log('ready.'))
  .catch(err => console.error(err))

call from client:

import { translate } from 'node-easynmt/client'

let zh = '世界你好'
let en = await translate({
  text: zh,
  source_lang: 'zh',
  target_lang: 'en',
})
console.log(`sample: ${zh} -> ${en}`)

Typescript Signature

Core Function: translate()

/**
 * @description set HTTP request to the translate service running in the docker container
 * */
export function translate(options: TranslateOptions): Promise<string>

export type TranslateOptions = {
  /** @default 'localhost' */
  host?: string
  /** @default 24080 */
  port?: number
  /** @example 'Hello World!' */
  text: string
  /** @example 'zh' */
  target_lang: string
  /** @description auto detect if not specified */
  source_lang?: string
  /** @default false */
  debug?: boolean
}

Patched core function: patchedTranslate()

/**
 * @description apply combination of fixes to workaround common errors
 */
export async function patchedTranslate(
  options: PatchedTranslateOptions,
): Promise<string>

export type PatchedTranslateOptions = TranslateOptions & {
  /**
   * @description to avoid ajax timeout when doing lots on translate concurrently
   * @default true
   * */
  async_queue?: boolean
  /**
   * @description to keep in-memory cache
   * @default true
   * */
  cached?: boolean
  /**
   * @description to avoid repeating (wrong) result.
   * e.g. without wrapping: Transparent -> 透明透明
   * @default true
   */
  wrap_text?: boolean
  /**
   * @description trim the output if the input is already trimmed
   * @default true
   */
  smart_trim?: boolean
}

Helper Functions:

/**
 * @description optionally step to preload the translate model before the actual usage.
 */
export async function preloadModel(options: {
  target_lang: string
  source_lang: string
  /**
   * @description to log in console or not
   * @default false
   *
   */
  debug?: boolean
}): Promise<void>

/**
 * @description release the memory used by patchedTranslate()
 */
export function clearCache(): void

Usage (cli)

run server:

docker run -p 24080:80 easynmt/api:2.0-cpu

send request:

curl "http://localhost:24080/translate?target_lang=en&text=Hallo%20Welt"

json response:

{
  "target_lang": "en",
  "source_lang": null,
  "detected_langs": ["de"],
  "translated": ["Hello world"],
  "translation_time": 77.64211463928223
}

License

This project is licensed with BSD-2-Clause

This is free, libre, and open-source software. It comes down to four essential freedoms [ref]:

• The freedom to run the program as you wish, for any purpose
• The freedom to study how the program works, and change it so it does your computing as you wish
• The freedom to redistribute copies so you can help others
• The freedom to distribute copies of your modified versions to others