Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beenotung/node-easynmt
multi-language translate using UKPLab/EasyNMT
https://github.com/beenotung/node-easynmt
api browser client docker easynmt http isomorphic m2m100 mbart50 neural-machine-translation node opus-mt server translation typescript wrapper
Last synced: 4 days ago
JSON representation
multi-language translate using UKPLab/EasyNMT
- Host: GitHub
- URL: https://github.com/beenotung/node-easynmt
- Owner: beenotung
- License: bsd-2-clause
- Created: 2024-04-09T10:01:19.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-04-23T15:55:26.000Z (9 months ago)
- Last Synced: 2024-04-23T18:57:44.437Z (9 months ago)
- Topics: api, browser, client, docker, easynmt, http, isomorphic, m2m100, mbart50, neural-machine-translation, node, opus-mt, server, translation, typescript, wrapper
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/node-easynmt
- Size: 21.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-EasyNMT
multi-language translate using [UKPLab/EasyNMT](https://github.com/UKPLab/EasyNMT)
[](https://www.npmjs.com/package/node-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)
```html
console.log(easyNMT)
/*
{
translate,
patchedTranslate,
clearCache,
preloadModel,
}
*/
```
## Usage (nodejs)
### Installation
```bash
npm i node-easynmt
```
run server:
```typescript
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:
```typescript
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()`
```typescript
/**
* @description set HTTP request to the translate service running in the docker container
* */
export function translate(options: TranslateOptions): Promise
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()`
```typescript
/**
* @description apply combination of fixes to workaround common errors
*/
export async function patchedTranslate(
options: PatchedTranslateOptions,
): Promise
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:
```typescript
/**
* @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
/**
* @description release the memory used by patchedTranslate()
*/
export function clearCache(): void
```
## Usage (cli)
run server:
```bash
docker run -p 24080:80 easynmt/api:2.0-cpu
```
send request:
```bash
curl "http://localhost:24080/translate?target_lang=en&text=Hallo%20Welt"
```
json response:
```json
{
"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](./LICENSE)
This is free, libre, and open-source software. It comes down to four essential freedoms [[ref]](https://seirdy.one/2021/01/27/whatsapp-and-the-domestication-of-users.html#fnref:2):
- 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