Add how-it-works diagram.

zh-plus · May 14, 2024 · 6abc13b · 6abc13b
1 parent 3b470d3
commit 6abc13b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -15,6 +15,7 @@ e.g. [OpenAI-GPT](https://github.com/openai/openai-python), [Anthropic-Claude](h
 - Well preprocessed audio to reduce hallucination (Loudness Norm & optional Noise Suppression).
 - Context-aware translation to improve translation quality.
   Check [prompt](https://github.com/zh-plus/openlrc/blob/master/openlrc/prompter.py) for details.
+- Check [here](#how-it-works) for an overview of the architecture.
 
 ## New 🚨
 
@@ -225,6 +226,12 @@ For english audio, we recommend using `gpt-3.5-turbo`.
 
 For non-english audio, we recommend using `claude-3-sonnet-20240229`.
 
+## How it works
+
+![](https://github.com/zh-plus/openlrc/blob/master/resources/how-it-works.png?raw=true)
+
+To maintain context between translation segments, the process is sequential for each audio file.
+
 ## Todo
 
 - [x] [Efficiency] Batched translate/polish for GPT request (enable contextual ability).

diff --git a/resources/how-it-works.png b/resources/how-it-works.png