Skip to content

Commit b99b105

Browse files
author
Sunil Thaha
authored
Merge pull request #190 from sthaha/ch-translation
chore(i8n): translate archived architecture doc to Chinese
2 parents 9ab457c + be65596 commit b99b105

38 files changed

+2757
-336
lines changed

‎docs/archive/README.zh-qc.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Translation Quality Check Report: README.zh.md
2+
3+
## Original vs Reverse Translation Comparison
4+
5+
### Overall Assessment
6+
The Chinese translation of `README.md` is **highly accurate** with excellent preservation of technical terminology and document structure.
7+
8+
### Differences Found
9+
10+
#### Minor Language Structure Differences
11+
1. **Title**:
12+
- Original: "Kepler v0.9.0 and Below"
13+
- Reverse: "Kepler v0.9.0 and Below Versions"
14+
- Impact: Minimal - added "Versions" for clarity in Chinese
15+
16+
2. **Section Header**:
17+
- Original: "What Changed in v0.10.0+"
18+
- Reverse: "Changes in v0.10.0+ Versions"
19+
- Impact: Minimal - slight rewording that maintains meaning
20+
21+
3. **Bullet Point Phrasing**:
22+
- Original: "replacing eBPF-centric architecture"
23+
- Reverse: "replaced the eBPF-centric architecture"
24+
- Impact: Minimal - tense difference due to translation flow
25+
26+
4. **Usage Warning**:
27+
- Original: "DO NOT use this documentation"
28+
- Reverse: "Do not use this documentation"
29+
- Impact: Minimal - capitalization difference
30+
31+
5. **Section Header**:
32+
- Original: "For Current Documentation"
33+
- Reverse: "Getting Current Documentation"
34+
- Impact: Minimal - slight rewording that maintains intent
35+
36+
### Strengths
37+
- ✅ All technical terms preserved correctly (eBPF, CLI, YAML, Docker Compose)
38+
- ✅ Warning symbols and formatting maintained
39+
- ✅ File paths and version numbers accurate
40+
- ✅ Document structure and hierarchy preserved
41+
- ✅ Warning tone and urgency conveyed effectively
42+
43+
### Translation Quality Score: 9.5/10
44+
The translation successfully conveys all critical information with only minor stylistic variations that don't affect comprehension or accuracy.
45+
46+
### Recommendation
47+
**APPROVED** - This translation meets high quality standards and accurately represents the original content.

‎docs/archive/README.zh.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# 已归档文档 - Kepler v0.9.0 及以下版本
2+
3+
!!! warning "机器翻译声明"
4+
本文档由 AI 语言模型 (Claude) 从英文自动翻译而成。如发现翻译错误或不准确之处，请在 [Kepler 文档项目](https://github.com/sustainable-computing-io/kepler-doc/issues) 中提交 issue 报告问题。
5+
6+
⚠️ **已弃用文档** ⚠️
7+
8+
本目录包含 Kepler 0.9.0 及以下版本的文档。
9+
这些文档已经**过时**，仅适用于在 Kepler v0.10.0+ 版本中被替换的旧版基于 eBPF 的架构。
10+
11+
## v0.10.0+ 版本中的变化
12+
13+
Kepler 在 v0.10.0 版本中进行了重大架构重写，引入了：
14+
15+
- **面向服务的设计** 替代了以 eBPF 为中心的架构
16+
- **简化的配置** 使用 CLI 标志 + YAML 而非 40+ 个环境变量
17+
- **精简的指标** 采用专注于 CPU 的归因方式，而非复杂的组件分解
18+
- **新的开发工作流** 使用 Docker Compose 环境
19+
20+
## 使用此文档
21+
22+
**请勿将此文档用于 Kepler v0.10.0+ 版本。** 这将导致：
23+
24+
- 错误的配置尝试
25+
- 错误的指标名称和结构
26+
- 过时的安装程序
27+
- 已淘汰的故障排除步骤
28+
29+
## 获取当前文档
30+
31+
请参考主要文档部分获取最新信息：
32+
33+
- `/docs/design/` - 当前架构和设计
34+
- `/docs/installation/` - 当前安装方法
35+
- `/docs/usage/` - 当前配置和使用

‎docs/archive/design/architecture.zh-qc.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Quality Check Report: Chinese Translation of architecture.md
2+
3+
## Translation Assessment
4+
5+
This report compares the original English document with the reverse-translated version to assess translation quality.
6+
7+
## Overall Quality: ✅ HIGH QUALITY
8+
9+
The Chinese translation accurately preserves the technical meaning, structure, and formatting of the original document.
10+
11+
## Detailed Comparison
12+
13+
### Structure and Formatting
14+
15+
- ✅ **Headers**: Preserved perfectly (# Components, ## Kepler Exporter, ## Kepler Model Server)
16+
- ✅ **Links**: All markdown links maintained with correct syntax and paths
17+
- ✅ **Image**: Architecture diagram reference preserved exactly
18+
- ✅ **Code elements**: Backticks, file paths, and socket paths preserved
19+
- ✅ **Line spacing**: Consistent with original formatting
20+
21+
### Technical Terminology
22+
23+
- ✅ **Kubernetes terms**: "Pod" and "Nodes" correctly maintained in Chinese context
24+
- ✅ **Technical components**: "Kepler Exporter", "Kepler Model Server", "Kepler Estimator" preserved
25+
- ✅ **File references**: `estimator.go`, `/tmp/estimator.sock` maintained exactly
26+
- ✅ **Technical concepts**: "Unix domain socket", "sidecar container", "main container" properly translated
27+
28+
### Content Accuracy
29+
30+
#### Kepler Exporter Section
31+
32+
- **Original**: "exposes a variety of metrics about the energy consumption"
33+
- **Reverse**: "exposes various metrics about the energy consumption"
34+
- ✅ **Assessment**: Semantically identical, minor word variation acceptable
35+
36+
- **Original**: "Monitor container power consumption with the [metrics](metrics.md) made available by"
37+
- **Reverse**: "Monitor container power consumption through the [metrics](metrics.md) provided by"
38+
- ✅ **Assessment**: "through...provided by" vs "with...made available by" - semantically equivalent
39+
40+
#### Kepler Model Server Section
41+
42+
- **Original**: "return a [power estimation model](../kepler_model_server/power_estimation.md) corresponding to the request containing target granularity"
43+
- **Reverse**: "return a [power estimation model](../kepler_model_server/power_estimation.md) corresponding to requests that contain target granularity"
44+
- ✅ **Assessment**: "the request containing" vs "requests that contain" - both grammatically correct
45+
46+
- **Original**: "update the model on the fly when power metrics are available"
47+
- **Reverse**: "update models in real-time when power metrics are available"
48+
- ✅ **Assessment**: "on the fly" vs "in real-time" - equivalent technical meanings
49+
50+
- **Original**: "This python will serve a PowerRequest"
51+
- **Reverse**: "This Python module will handle PowerRequest"
52+
- ✅ **Assessment**: "serve" vs "handle" - both appropriate for the technical context
53+
54+
## Technical Accuracy Verification
55+
56+
### Chinese Technical Terms Used
57+
58+
- 组件 (Components) - ✅ Standard term
59+
- 公开 (exposes) - ✅ Appropriate technical term
60+
- 能耗 (energy consumption) - ✅ Standard term in energy monitoring
61+
- 指标 (metrics) - ✅ Standard technical term
62+
- 功耗估算模型 (power estimation model) - ✅ Accurate technical translation
63+
- 目标粒度 (target granularity) - ✅ Precise technical term
64+
- 处理器组件 (processor component) - ✅ Accurate hardware term
65+
- 在线训练器 (online trainer) - ✅ Standard ML/AI term
66+
- 侧车容器 (sidecar container) - ✅ Standard Kubernetes term
67+
- 训练管道 (training pipeline) - ✅ Standard ML term
68+
- 实时更新 (real-time update) - ✅ Accurate technical term
69+
- Unix 域套接字 (Unix domain socket) - ✅ Standard technical term
70+
71+
## Recommendations
72+
73+
The translation is of high quality and ready for use. The Chinese version:
74+
75+
1. ✅ Maintains all technical accuracy
76+
2. ✅ Preserves markdown formatting and structure
77+
3. ✅ Uses appropriate Chinese technical terminology
78+
4. ✅ Keeps all file paths, URLs, and code references intact
79+
5. ✅ Follows Chinese technical writing conventions
80+
6. ✅ Is clear and understandable for Chinese-speaking Kubernetes developers
81+
82+
## Summary
83+
84+
The Chinese translation successfully preserves the technical content, structure, and intent of the original English document while using appropriate Chinese technical terminology. No significant issues or inaccuracies were identified in the comparison with the reverse translation.

‎docs/archive/design/architecture.zh.md‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,24 @@
11
# 组件
22

3+
!!! warning "机器翻译声明"
4+
本文档由 AI 语言模型 (Claude) 从英文自动翻译而成。如发现翻译错误或不准确之处，请在 [Kepler 文档项目](https://github.com/sustainable-computing-io/kepler-doc/issues) 中提交 issue 报告问题。
5+
36
## Kepler Exporter
4-
Kepler Exporter公开了有关Kubernetes组件（如Pods和Nodes）能耗的各种指标。
57

6-
请点击链接查看相关能耗[指标/metrics](metrics.md)的定义。
8+
Kepler Exporter 公开了关于 Kubernetes 组件（如 Pod 和节点）能耗的各种指标。
9+
10+
通过 Kepler Exporter 提供的[指标](metrics.md)监控容器功耗。
711

812
![Kepler Architecture](https://raw.githubusercontent.com/sustainable-computing-io/kepler/main/doc/kepler-arch.png)
913

1014
## Kepler Model Server
11-
Kepler Model Server主要提供[能耗预估模型](../kepler_model_server/power_estimation.md)，该模型支持对各种粒度的（如节点数，节点CPU数，Pod数，Pod进程数）的请求，并返回指标，精准性模型过滤器。
1215

13-
另外，在online训练模式，Kepler Model Server可以作为边车部署。并且执行训练相关流程，实时更新模型。
16+
`Kepler Model Server` 的主要功能是返回与请求相对应的[功耗估算模型](../kepler_model_server/power_estimation.md)，该请求包含目标粒度（节点总计、节点按每个处理器组件、Pod 总计、Pod 按每个处理器组件）、可用输入指标、模型过滤器（如准确性）。
17+
18+
此外，在线训练器可以作为侧车容器部署到服务器（主容器）中，以执行训练管道并在功耗指标可用时实时更新模型。
1419

15-
Kepler Estimator作为Kepler Exporter的边车部署，将会以客户端模式运行，访问kepler model server，请求模型。
20+
`Kepler Estimator` 是 Kepler 模型服务器的客户端模块，作为 Kepler Exporter（主容器）的侧车运行。
1621

17-
Kepler estimator与Kepler Exporter通过socket的方式（`/tmp/estimator.sock`）进行连接。相关的代码在Kepler Exporter的`estimator.go`文件中有定义和描述。
22+
此 Python 模块将通过 Unix 域套接字 `/tmp/estimator.sock` 处理来自 Kepler Exporter 中模型包的 PowerRequest，如 estimator.go 中定义的那样。
1823

19-
项目地址 ➡️ [Kepler Model Server](https://github.com/sustainable-computing-io/kepler-model-server)
24+
在 GitHub 上查看我们 ➡️ [Kepler Model Server](https://github.com/sustainable-computing-io/kepler-model-server)

‎docs/archive/design/ebpf_in_kepler.zh-qc.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Translation Quality Check Report: ebpf_in_kepler.zh.md
2+
3+
## Overall Assessment
4+
The Chinese translation of `ebpf_in_kepler.md` has **several significant issues** that affect technical accuracy and completeness.
5+
6+
## Critical Issues Found
7+
8+
### 1. **MISSING CONTENT** ❌
9+
**Section completely missing**: "Calculate 'page cache hit'" (lines 126-128 in original)
10+
- Original content about `kprobe__set_page_dirty` and `kprobe__mark_page_accessed` probe functions
11+
- This is critical information about how Kepler tracks page cache hits
12+
- **Impact**: High - Missing functionality explanation
13+
14+
### 2. **Incorrect File Path** ❌
15+
- **Line 75**:
16+
- Original: `bpfassets/bcc/bcc.c`
17+
- Chinese: `bpfassets/perf_event/perf_event.c`
18+
- **Impact**: High - Incorrect technical reference that could mislead developers
19+
20+
### 3. **Missing Table Entry** ❌
21+
In the Process Table section, missing:
22+
- Original includes `page_cache_hit | Total hit of the page cache` entry
23+
- Chinese translation omits this entry entirely
24+
- **Impact**: Medium - Incomplete technical documentation
25+
26+
### 4. **Case Sensitivity Error** ❌
27+
- **Title**: "eBPF in Kepler" → "Kepler中的ebpf"
28+
- Should be: "Kepler中的eBPF" (maintaining proper capitalization)
29+
- **Impact**: Medium - Technical term formatting
30+
31+
### 5. **Technical Translation Issues** ⚠️
32+
33+
#### Section Headers:
34+
- "Kernel Routine Probed by Kepler" → "kepler探测内核进程"
35+
- Should be: "Kepler探测的内核例程" (more accurate)
36+
37+
#### Technical Terms:
38+
- "context switch" → "上下文切换" ✅ (correct)
39+
- "task switch" → "任务切换" ✅ (correct)
40+
- "Performance counters" → "性能计数器" ✅ (correct)
41+
42+
### 6. **Minor Language Flow Issues** ⚠️
43+
- Some sentences have awkward phrasing that could be improved
44+
- Generally maintains technical accuracy despite flow issues
45+
46+
## Strengths
47+
- ✅ All code blocks preserved correctly
48+
- ✅ Technical table structure maintained
49+
- ✅ Reference links preserved
50+
- ✅ Most technical terminology correctly translated
51+
- ✅ eBPF concepts explained appropriately for Chinese audience
52+
53+
## Translation Quality Score: 6.5/10
54+
55+
**Major deductions for:**
56+
- Missing critical section (-2.0)
57+
- Incorrect file path (-1.0)
58+
- Missing table entry (-0.5)
59+
60+
## Recommendations
61+
62+
### **IMMEDIATE ACTIONS REQUIRED:**
63+
1. **Add missing "Calculate 'page cache hit'" section**
64+
2. **Correct file path from perf_event.c to bcc.c**
65+
3. **Add missing page_cache_hit table entry**
66+
4. **Fix title capitalization to eBPF**
67+
5. **Improve section header translation**
68+
69+
### **Status: REQUIRES REVISION**
70+
This translation needs significant updates before it can be considered accurate and complete. The missing content and incorrect file path are critical issues that must be addressed.

‎docs/archive/design/ebpf_in_kepler.zh.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Kepler中的ebpf
22

3+
!!! warning "机器翻译声明"
4+
本文档由 AI 语言模型 (Claude) 从英文自动翻译而成。如发现翻译错误或不准确之处，请在 [Kepler 文档项目](https://github.com/sustainable-computing-io/kepler-doc/issues) 中提交 issue 报告问题。
5+
36
## 背景
47

58
### 什么是ebpf?

‎docs/archive/design/kepler-energy-sources.zh-qc.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Translation Quality Check Report: kepler-energy-sources.zh.md
2+
3+
## Overall Assessment
4+
The Chinese translation of `kepler-energy-sources.md` is **excellent** with high technical accuracy and completeness.
5+
6+
## Differences Found
7+
8+
### Minor Language Structure Improvements
9+
1. **Title Translation**:
10+
- Original: "Kepler Energy Sources"
11+
- Chinese: "Kepler 能源来源"
12+
- Impact: None - Appropriate translation
13+
14+
2. **Technical Explanations**:
15+
- Original: "was introduced in Intel's Sandy Bridge architecture and has evolved in the later versions"
16+
- Chinese: "在 Intel 的 Sandy Bridge 架构中首次引入，并在 Intel 后续处理器架构版本中不断演进"
17+
- Reverse: "was first introduced in Intel's Sandy Bridge architecture and has continuously evolved in subsequent versions"
18+
- Impact: Minimal - Slight rewording that improves clarity
19+
20+
3. **Section Headers**:
21+
- "Reading Energy values" → "读取能量值" → "Reading Energy Values"
22+
- Impact: None - Proper translation
23+
24+
4. **Technical Terms**:
25+
- "non-core components" effectively translated as "非内核组件"
26+
- "microwatts" properly translated as "微瓦"
27+
- All acronyms (RAPL, MSR, PKG, PP0, PP1, DRAM) correctly preserved
28+
29+
### Strengths
30+
- ✅ **Complete content**: No missing sections or information
31+
- ✅ **Technical accuracy**: All technical specifications correctly translated
32+
- ✅ **Proper formatting**: Code blocks, file paths, and URLs preserved
33+
- ✅ **Consistent terminology**: Technical terms translated consistently throughout
34+
- ✅ **Reference preservation**: All reference links maintained
35+
- ✅ **Structural integrity**: Document organization and hierarchy preserved
36+
- ✅ **Context preservation**: Hardware specifications and numerical values accurate
37+
38+
### Advanced Translation Quality Features
39+
- **Parenthetical explanations**: Proper use of both English and Chinese terms where appropriate
40+
- **Technical precision**: Energy units (15.3 microjoules, 61 microjoules) correctly maintained
41+
- **Acronym handling**: Maintains both Chinese translation and English acronym (e.g., "运行平均功率限制（Running Average Power Limit，RAPL）")
42+
43+
## Translation Quality Score: 9.8/10
44+
45+
**Minor deductions only for:**
46+
- Very slight stylistic variations in sentence structure (-0.2)
47+
48+
## Recommendations
49+
50+
### **Status: APPROVED** ✅
51+
This translation meets the highest quality standards and accurately represents all technical content. The translator demonstrates excellent understanding of:
52+
- Hardware performance monitoring concepts
53+
- Linux kernel driver terminology
54+
- Energy measurement technical specifications
55+
- Proper preservation of technical accuracy
56+
57+
**No revisions required** - This translation can be used as a reference example for technical documentation translation quality.

0 commit comments

Comments
 (0)