Skip to main content

A tool to translate markdown files using GPT-4

Project description

PyPI version Weave

gpt_translate: Translating MD files with GPT-4

This is a tool to translate Markdown files without breaking the structure of the document. It is powered by OpenAI models and has multiple parsing and formatting options. The provided default example is the one we use to translate our documentation website docs.wandb.ai to japanese and korean.

You can click here to see the output of the translation on the screenshot above.

Installation

We have a stable version on PyPI, so you can install it with pip:

$ pip install gpt-translate

or to get latest version from the repo:

$ cd gpt_translate
$ pip install .

Export your OpenAI API key:

export OPENAI_API_KEY=aa-proj-bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb

Usage

The library provides a set of commands that you can access as CLI. All the commands start by gpt_translate.:

  • gpt_translate.file: Translate a single file
  • gpt_translate.folder: Translate a folder recursively
  • gpt_translate.files: Translate a list of files, accepts .txt list of files as input.

We use GPT4 by default. You can change this on configs/config.yaml. The dafault values are:

# Logs:
debug: false  # Debug mode
weave_project: "gpt-translate"  # Weave project
silence_openai: true  # Silence OpenAI logger

# Translation:
language: "ja"  # Language to translate to
config_folder: "./configs"  # Config folder, where the prompts and dictionaries are
replace: true  # Replace existing file
remove_comments: true  # Remove comments
do_translate_header_description: true  # Translate the header description
max_openai_concurrent_calls: 7  # Max number of concurrent calls to OpenAI

# Files:
input_file: "docs/intro.md"  # File to translate
out_file: " intro_ja.md"  # File to save the translated file to
input_folder: null  # Folder to translate
out_folder: null  # Folder to save the translated files to
limit: null  # Limit number of files to translate

# Model:
model: "gpt-4o"
temperature: 1.0
max_tokens: 4096

You can override the arguments at runtime or by creating another config.yaml file. You can also use the --config_path flag to specify a different config file.

  • The --config_folder argument is where the prompts and dictionaries are located, the actual config.yaml could be located somewhere else. Maybe I need a better naming here =P.

  • You can add new languages by providing the language translation dictionaries in configs/language_dicts

Examples

  1. To translate a single file:
$ gpt_translate.file \
  --input_file README.md \
  --out_file README_es_.md \
  --language es
  --config_folder ./configs
  1. Translate a list of files from list.txt:
$ gpt_translate.files \
  --input_file list.txt \
  --input_folder docs \ 
  --out_folder docs_ja \
  --language ja
  --config_folder ./configs

Note here that we need to pass and input and output folder. This is because we will be using the input folder to get the relative path and create the same folder structure in the output folder. This is tipically what you want for documentation websites that are organized in folders like ./docs.

  1. Translate a full folder recursively:
$ gpt_translate.folder \
  --input_folder docs \
  --out_folder docs_ja \
  --language ja
  --config_folder ./configs

If you don't know what to do, you can always do --help on any of the commands:

$ gpt_translate.* --help

Weave Tracing

The library does a lot! keeping track of every piece of interaction is necessary. We added W&B Weave support to trace every call to the model and underlying processing bits.

You can pass a project name to the CLI to trace the calls:

$ gpt_translate.folder \
  --input_folder docs \
  --output_folder docs_ja \
  --language ja \
  --weave_project gpt-translate
  --config_folder ./configs

Weave Tracing

Evaluation

Once the translation is done, you can evaluate the quality of the translation by running:

$ gpt_translate.eval \
  --eval_dataset "Translation-ja:latest"

You can iterate on the translation prompts and dictionaries to improve the quality of the translation.

Weave Evaluation

The config for the evaluation shares many similarities with the translation config, which is stored in configs/eval_config.yaml. The configs/evaluation_prompt.txt file contains the prompt used by the LLM Judge to evaluate the translation quality. Feel free to play with it to find better ways to evaluate the quality of the translation according to your needs.

Whenever you run gpt_translate.files or gpt_translate.folder, it automatically creates a new Weave Dataset with the name in the format Translation-{language}:{timestamp}.

Weave Dataset

Github Action

We supply an action.yml file to use this library in a Github Action. It is not much tested, but it should work.

  • You will need to setup your Weights & Biases API key as a secret in your Github repository as WANDB_API_KEY.

An example workflow is shown in https://github.com/tcapelle/dummy_docs and the corresponding workflow file

TroubleShooting

If you have any issue, you can always pass the --debug flag to get more information about what is happening:

$ gpt_translate.folder ... --debug

this will get you a very verbose output (calls to models, inputs and outputs, etc.)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gpt_translate-4.0.0.tar.gz (18.9 kB view details)

Uploaded Source

Built Distribution

gpt_translate-4.0.0-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file gpt_translate-4.0.0.tar.gz.

File metadata

  • Download URL: gpt_translate-4.0.0.tar.gz
  • Upload date:
  • Size: 18.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for gpt_translate-4.0.0.tar.gz
Algorithm Hash digest
SHA256 cb96348297b7753994566459739d8d420c14a559884d93fe80514f837eaaa006
MD5 1a145f434a627fe55309dafb80ec9918
BLAKE2b-256 859e467cec40f0817c6e68075413d6b508874b1cb69a99110f518de46a389343

See more details on using hashes here.

File details

Details for the file gpt_translate-4.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for gpt_translate-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9798644b80c97c7d73921c2a18219f1e9ddf9f95d4cedbcf0cd655530e8ca3e3
MD5 9b5468b3e4e4f5618ef4968aed371423
BLAKE2b-256 5f1c10aa3ce3915aca6d289f47bf053da26498925b7fd8e63aab2bb25a44c9d4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page