# wzhy233/opentranslatorlite architecture

> Architecture diagram of the GitHub repository wzhy233/opentranslatorlite, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/wzhy233/opentranslatorlite
- Repository: https://github.com/wzhy233/opentranslatorlite

## Overview

OpenTranslatorLite is an offline Java translation library backed by a CTranslate2 Python worker. Its main workflow initializes the runtime and cache, then accepts synchronous, asynchronous, or batch translation requests through Translator; translations use cached results where available and otherwise go through the model bridge to the worker. Setup checks, configuration, model downloads, and the optional full-build setup UI are separate supporting capabilities. Edges reflect shown calls or documented behavior; unsampled implementation details are omitted rather than inferred.

Main entry points: [`src/main/java/io/github/wzhy233/open_translator/runtime/RuntimeManager.java`](https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/runtime/RuntimeManager.java) (Runtime manager), [`src/main/java/io/github/wzhy233/open_translator/Translator.java`](https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/Translator.java) (Translator API), [`src/main/java/io/github/wzhy233/open_translator/model/TranslationModel.java`](https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/model/TranslationModel.java) (Model bridge), [`src/full/java/io/github/wzhy233/open_translator/setup/SetupWizard.java`](https://github.com/wzhy233/opentranslatorlite/blob/master/src/full/java/io/github/wzhy233/open_translator/setup/SetupWizard.java) (Setup wizard)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Translation API"]
  node_translator["Translator API<br/>[Translator.java]"]
end

subgraph group_engine["Translation Engine"]
  node_model["Model bridge"]
  node_worker["CTranslate2 worker"]
  node_models[("Local model assets")]
  node_buildinfo["Build metadata<br/>[BuildInfo.java]"]
end

subgraph group_setup["Runtime Setup"]
  node_runtime["Runtime manager"]
  node_status["Setup status<br/>[SetupStatus.java]"]
  node_wizard["Setup wizard<br/>[SetupWizard.java]"]
  node_launcher["Wizard launcher"]
  node_download["Model downloader"]
end

subgraph group_state["Configuration and State"]
  node_cache["Translation cache<br/>[CacheManager.java]"]
  node_cachefiles[("Cache files")]
  node_config["Configuration manager<br/>[ConfigManager.java]"]
  node_configfiles[("Config files")]
end

node_user(("Java caller"))
node_huggingface["Hugging Face Hub"]
node_python["Python runtime"]

node_user -->|"calls translate"| node_translator
node_translator -->|"checks and stores"| node_cache
node_translator -->|"initializes model"| node_model
node_cache -->|"reads and writes"| node_cachefiles
node_model -->|"checks readiness"| node_runtime
node_model -->|"starts and requests"| node_worker
node_worker -->|"loads model assets"| node_models
node_runtime -->|"populates status"| node_status
node_runtime -->|"reads and saves"| node_config
node_config -->|"reads and writes"| node_configfiles
node_runtime -->|"launches optionally"| node_wizard
node_wizard -->|"runs setup actions"| node_runtime
node_launcher -->|"inspects runtime"| node_runtime
node_launcher -->|"opens wizard"| node_wizard
node_runtime -->|"runs downloader"| node_download
node_download -->|"downloads snapshots"| node_huggingface
node_runtime -->|"checks and runs"| node_python
node_model -->|"starts worker process"| node_python
node_translator -->|"reads build details"| node_buildinfo

click node_translator "https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/Translator.java"
click node_cache "https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/cache/CacheManager.java"
click node_model "https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/model/TranslationModel.java"
click node_worker "https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/resources/python/ctranslate2_worker.py"
click node_runtime "https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/runtime/RuntimeManager.java"
click node_status "https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/setup/SetupStatus.java"
click node_wizard "https://github.com/wzhy233/opentranslatorlite/blob/master/src/full/java/io/github/wzhy233/open_translator/setup/SetupWizard.java"
click node_launcher "https://github.com/wzhy233/opentranslatorlite/blob/master/src/full/java/io/github/wzhy233/open_translator/setup/SetupWizardLauncher.java"
click node_download "https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/resources/python/ctranslate2_model_setup.py"
click node_config "https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/config/ConfigManager.java"
click node_buildinfo "https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/BuildInfo.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_translator toneBlue
class node_model,node_worker,node_models,node_buildinfo toneAmber
class node_runtime,node_status,node_wizard,node_launcher,node_download toneMint
class node_cache,node_cachefiles,node_config,node_configfiles toneRose
class node_user,node_huggingface,node_python toneIndigo
```

## Components

### Translation API

- [Translator API](https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/Translator.java): `src/main/java/io/github/wzhy233/open_translator/Translator.java`

### Translation Engine

- [Model bridge](https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/model/TranslationModel.java): `src/main/java/io/github/wzhy233/open_translator/model/TranslationModel.java`
- [CTranslate2 worker](https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/resources/python/ctranslate2_worker.py): `src/main/resources/python/ctranslate2_worker.py`
- **Local model assets**
- [Build metadata](https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/BuildInfo.java): `src/main/java/io/github/wzhy233/open_translator/BuildInfo.java`

### Runtime Setup

- [Runtime manager](https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/runtime/RuntimeManager.java): `src/main/java/io/github/wzhy233/open_translator/runtime/RuntimeManager.java`
- [Setup status](https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/setup/SetupStatus.java): `src/main/java/io/github/wzhy233/open_translator/setup/SetupStatus.java`
- [Setup wizard](https://github.com/wzhy233/opentranslatorlite/blob/master/src/full/java/io/github/wzhy233/open_translator/setup/SetupWizard.java): `src/full/java/io/github/wzhy233/open_translator/setup/SetupWizard.java`
- [Wizard launcher](https://github.com/wzhy233/opentranslatorlite/blob/master/src/full/java/io/github/wzhy233/open_translator/setup/SetupWizardLauncher.java): `src/full/java/io/github/wzhy233/open_translator/setup/SetupWizardLauncher.java`
- [Model downloader](https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/resources/python/ctranslate2_model_setup.py): `src/main/resources/python/ctranslate2_model_setup.py`

### Configuration and State

- [Translation cache](https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/cache/CacheManager.java): `src/main/java/io/github/wzhy233/open_translator/cache/CacheManager.java`
- **Cache files**
- [Configuration manager](https://github.com/wzhy233/opentranslatorlite/blob/master/src/main/java/io/github/wzhy233/open_translator/config/ConfigManager.java): `src/main/java/io/github/wzhy233/open_translator/config/ConfigManager.java`
- **Config files**

### Other components

- **Java caller**
- **Hugging Face Hub**
- **Python runtime**

## Connections

- Java caller → Translator API: calls translate (evidence: `README.md`)
- Translator API → Translation cache: checks and stores (evidence: `src/main/java/io/github/wzhy233/open_translator/Translator.java`)
- Translator API → Model bridge: initializes model (evidence: `src/main/java/io/github/wzhy233/open_translator/Translator.java`)
- Translation cache → Cache files: reads and writes (evidence: `src/main/java/io/github/wzhy233/open_translator/cache/CacheManager.java`)
- Model bridge → Runtime manager: checks readiness (evidence: `src/main/java/io/github/wzhy233/open_translator/model/TranslationModel.java`)
- Model bridge → CTranslate2 worker: starts and requests (evidence: `src/main/java/io/github/wzhy233/open_translator/model/TranslationModel.java`)
- CTranslate2 worker → Local model assets: loads model assets (evidence: `src/main/resources/python/ctranslate2_worker.py`)
- Runtime manager → Setup status: populates status (evidence: `src/main/java/io/github/wzhy233/open_translator/runtime/RuntimeManager.java`)
- Runtime manager → Configuration manager: reads and saves (evidence: `src/main/java/io/github/wzhy233/open_translator/runtime/RuntimeManager.java`)
- Configuration manager → Config files: reads and writes (evidence: `src/main/java/io/github/wzhy233/open_translator/config/ConfigManager.java`)
- Runtime manager → Setup wizard: launches optionally (evidence: `src/main/java/io/github/wzhy233/open_translator/runtime/RuntimeManager.java`)
- Setup wizard → Runtime manager: runs setup actions (evidence: `src/full/java/io/github/wzhy233/open_translator/setup/SetupWizard.java`)
- Wizard launcher → Runtime manager: inspects runtime (evidence: `src/full/java/io/github/wzhy233/open_translator/setup/SetupWizardLauncher.java`)
- Wizard launcher → Setup wizard: opens wizard (evidence: `src/full/java/io/github/wzhy233/open_translator/setup/SetupWizardLauncher.java`)
- Runtime manager → Model downloader: runs downloader (evidence: `src/main/java/io/github/wzhy233/open_translator/runtime/RuntimeManager.java`)
- Model downloader → Hugging Face Hub: downloads snapshots (evidence: `src/main/resources/python/ctranslate2_model_setup.py`)
- Runtime manager → Python runtime: checks and runs (evidence: `src/main/java/io/github/wzhy233/open_translator/runtime/RuntimeManager.java`)
- Model bridge → Python runtime: starts worker process (evidence: `src/main/java/io/github/wzhy233/open_translator/model/TranslationModel.java`)
- Translator API → Build metadata: reads build details (evidence: `src/main/java/io/github/wzhy233/open_translator/Translator.java`)
