Protect HTML literal contents during translation retries

Treat HTML code-like elements as atomic protected values and revalidate cached translations against the current protection scheme.

Files changed (4) hide show

src/hf_doc_translation/protect.py +9 -0
src/hf_doc_translation/sync.py +23 -2
tests/test_protection.py +13 -0
tests/test_sync.py +69 -0

src/hf_doc_translation/protect.py CHANGED Viewed

@@ -14,6 +14,10 @@ class ProtectionError(ValueError):
 _SENTINEL_RE = re.compile(r"\ue000HFDT(?P<index>\d{4})(?P<digest>[0-9a-f]{8})\ue001")
 _INLINE_CODE_RE = re.compile(r"(?P<ticks>`+)(?P<body>[^\n]*?)(?P=ticks)")
 _LINK_TARGET_RE = re.compile(r"\]\((?P<target>[^)\n]+)\)")
 _HTML_TAG_RE = re.compile(r"</?[A-Za-z][^>\n]*>|<!--[\s\S]*?-->")
 _DIRECTIVE_RE = re.compile(r"\[\[[^\n\]]+\]\]")
@@ -84,6 +88,11 @@ def protect_text(text: str, glossary: Iterable[str] = (), sentinel_offset: int =
     # Protect larger syntax spans first. Otherwise a glossary term inside an
     # inline-code span would create nested sentinels that the model could not
     # reproduce as a legal sequence.
     protected = _replace_matches(protected, _INLINE_CODE_RE, add)
     # Keep link labels available for translation while protecting only their targets.
     protected = _replace_matches(protected, _LINK_TARGET_RE, add, group="target")

 _SENTINEL_RE = re.compile(r"\ue000HFDT(?P<index>\d{4})(?P<digest>[0-9a-f]{8})\ue001")
 _INLINE_CODE_RE = re.compile(r"(?P<ticks>`+)(?P<body>[^\n]*?)(?P=ticks)")
+_HTML_LITERAL_RE = re.compile(
+    r"<(?P<tag>code|kbd|samp|var)\b[^>]*>[\s\S]*?</(?P=tag)\s*>",
+    re.IGNORECASE,
+)
 _LINK_TARGET_RE = re.compile(r"\]\((?P<target>[^)\n]+)\)")
 _HTML_TAG_RE = re.compile(r"</?[A-Za-z][^>\n]*>|<!--[\s\S]*?-->")
 _DIRECTIVE_RE = re.compile(r"\[\[[^\n\]]+\]\]")
     # Protect larger syntax spans first. Otherwise a glossary term inside an
     # inline-code span would create nested sentinels that the model could not
     # reproduce as a legal sequence.
+    # HTML literal elements are equivalent to Markdown inline code: protect
+    # both their tags and contents as one atomic value. Protecting only the
+    # tags would expose identifiers such as ``flash_attention_3`` as prose
+    # during sentinel-free retries.
+    protected = _replace_matches(protected, _HTML_LITERAL_RE, add)
     protected = _replace_matches(protected, _INLINE_CODE_RE, add)
     # Keep link labels available for translation while protecting only their targets.
     protected = _replace_matches(protected, _LINK_TARGET_RE, add, group="target")

src/hf_doc_translation/sync.py CHANGED Viewed

@@ -364,6 +364,21 @@ def _translate_segment_with_retry(
         ) from retry_error
 def _manifest_base(config: TranslationConfig, source_sha: str, runner_revision: str, doc_builder_revision: str) -> dict[str, Any]:
     return {
         "runner_revision": runner_revision,
@@ -489,6 +504,7 @@ def run_sync(args: argparse.Namespace) -> dict[str, Any]:
             manifest["metrics"] = {
                 "cache_hits": 0,
                 "cache_misses": 0,
                 "retries": 0,
                 "sentinel_safe_retries": 0,
                 "translation": {},
@@ -500,6 +516,7 @@ def run_sync(args: argparse.Namespace) -> dict[str, Any]:
         translations: dict[str, str] = {}
         cache_hits = 0
         cache_misses = 0
         retry_metrics: dict[str, int] = {}
         all_segments = [segment for page in pages for segment in page.segments]
         if toc is not None:
@@ -510,10 +527,13 @@ def run_sync(args: argparse.Namespace) -> dict[str, Any]:
             for segment in all_segments:
                 key = segment_cache_key(segment.source, config)
                 record = None if args.check_only else cache.get(key)
-                if record is not None:
-                    translations[segment.key] = record["translated"]
                     cache_hits += 1
                 else:
                     cache_misses += 1
                     pending.append(segment)
                     pending_keys.append(key)
@@ -598,6 +618,7 @@ def run_sync(args: argparse.Namespace) -> dict[str, Any]:
             manifest["metrics"] = {
                 "cache_hits": cache_hits,
                 "cache_misses": cache_misses,
                 "retries": retry_metrics.get("retries", 0),
                 "sentinel_safe_retries": retry_metrics.get("sentinel_safe_retries", 0),
                 "translation": metrics.as_dict() if metrics is not None else {},

         ) from retry_error
+def _validated_cached_translation(record, segment, config: TranslationConfig) -> str | None:
+    """Return a cache hit only when it matches the current protection scheme."""
+    if record is None:
+        return None
+    translated = record.get("translated")
+    if not isinstance(translated, str):
+        return None
+    try:
+        validate_segment(segment.source, translated, segment.protected, config)
+    except (TypeError, ValueError):
+        return None
+    return translated
 def _manifest_base(config: TranslationConfig, source_sha: str, runner_revision: str, doc_builder_revision: str) -> dict[str, Any]:
     return {
         "runner_revision": runner_revision,
             manifest["metrics"] = {
                 "cache_hits": 0,
                 "cache_misses": 0,
+                "cache_rejections": 0,
                 "retries": 0,
                 "sentinel_safe_retries": 0,
                 "translation": {},
         translations: dict[str, str] = {}
         cache_hits = 0
         cache_misses = 0
+        cache_rejections = 0
         retry_metrics: dict[str, int] = {}
         all_segments = [segment for page in pages for segment in page.segments]
         if toc is not None:
             for segment in all_segments:
                 key = segment_cache_key(segment.source, config)
                 record = None if args.check_only else cache.get(key)
+                cached_translation = _validated_cached_translation(record, segment, config)
+                if cached_translation is not None:
+                    translations[segment.key] = cached_translation
                     cache_hits += 1
                 else:
+                    if record is not None:
+                        cache_rejections += 1
                     cache_misses += 1
                     pending.append(segment)
                     pending_keys.append(key)
             manifest["metrics"] = {
                 "cache_hits": cache_hits,
                 "cache_misses": cache_misses,
+                "cache_rejections": cache_rejections,
                 "retries": retry_metrics.get("retries", 0),
                 "sentinel_safe_retries": retry_metrics.get("sentinel_safe_retries", 0),
                 "translation": metrics.as_dict() if metrics is not None else {},

tests/test_protection.py CHANGED Viewed

@@ -43,6 +43,19 @@ class ProtectionTest(unittest.TestCase):
         self.assertEqual(rebuilt, protected.text)
         self.assertEqual(protected.restore(rebuilt), source)
 if __name__ == "__main__":
     unittest.main()

         self.assertEqual(rebuilt, protected.text)
         self.assertEqual(protected.restore(rebuilt), source)
+    def test_html_literal_elements_are_atomic_protected_values(self):
+        source = (
+            '<tr><td><code>"flash_attention_3"</code></td>'
+            '<td>Improves FlashAttention-2.</td></tr>\n'
+        )
+        protected = protect_text(source)
+        chunks, _ = split_sentinel_chunks(protected.text)
+        self.assertIn('<code>"flash_attention_3"</code>', protected.values)
+        self.assertFalse(any("flash_attention_3" in chunk for chunk in chunks))
+        self.assertEqual(protected.restore(protected.text), source)
 if __name__ == "__main__":
     unittest.main()

tests/test_sync.py CHANGED Viewed

@@ -14,6 +14,7 @@ from hf_doc_translation.sync import (
     _resolve_checkout,
     _sentence_parts,
     _translate_segment_with_retry,
     run_sync,
 )
 from hf_doc_translation.translate import ContinuousBatchTranslator, _causal_lm_load_spec
@@ -131,6 +132,74 @@ class SyncTest(unittest.TestCase):
         restored = segment.protected.restore(response)
         self.assertTrue(all(value in restored for value in segment.protected.values))
     def test_initial_rollout_disables_graph_and_async_warmup(self):
         root = Path(__file__).parents[1]
         for config_name in ("transformers-ja.yml", "transformers-ja-job.yml"):

     _resolve_checkout,
     _sentence_parts,
     _translate_segment_with_retry,
+    _validated_cached_translation,
     run_sync,
 )
 from hf_doc_translation.translate import ContinuousBatchTranslator, _causal_lm_load_spec
         restored = segment.protected.restore(response)
         self.assertTrue(all(value in restored for value in segment.protected.values))
+    def test_sentinel_free_retry_never_translates_html_code_contents(self):
+        config = SimpleNamespace(
+            glossary=(),
+            validation={
+                "min_japanese_characters": 1,
+                "max_untranslated_english_ratio": 1.0,
+                "min_length_ratio": 0.1,
+                "max_length_ratio": 4.0,
+            },
+            continuous_batching={"max_requests_per_batch": 32},
+        )
+        page = parse_markdown(
+            Path("attention_interface.md"),
+            (
+                '<tr><td><code>"flash_attention_3"</code></td>'
+                '<td>Improves FlashAttention-2.</td></tr>\n'
+            ),
+        )
+        segment = page.segments[0]
+        class Translator:
+            def __init__(self):
+                self.calls = []
+            def translate_many(self, texts):
+                self.calls.append(list(texts))
+                return ["改善します。" for _ in texts]
+        translator = Translator()
+        response = _translate_segment_with_retry(
+            segment,
+            translator,
+            config,
+            {},
+            initial_error=ValueError("model changed literal tokens"),
+        )
+        requests = [text for call in translator.calls for text in call]
+        self.assertFalse(any("flash_attention_3" in text for text in requests))
+        self.assertIn(
+            '<code>"flash_attention_3"</code>',
+            segment.protected.restore(response),
+        )
+    def test_cache_hit_must_match_current_protection_scheme(self):
+        config = SimpleNamespace(
+            validation={
+                "min_japanese_characters": 1,
+                "max_untranslated_english_ratio": 1.0,
+                "min_length_ratio": 0.1,
+                "max_length_ratio": 4.0,
+            },
+        )
+        segment = parse_markdown(
+            Path("page.md"),
+            '<code>"flash_attention_3"</code> backend.\n',
+        ).segments[0]
+        valid = segment.protected.text.replace(" backend", " バックエンド")
+        stale = valid.replace(segment.protected.sentinels[0], "", 1)
+        self.assertEqual(
+            _validated_cached_translation({"translated": valid}, segment, config),
+            valid,
+        )
+        self.assertIsNone(
+            _validated_cached_translation({"translated": stale}, segment, config)
+        )
     def test_initial_rollout_disables_graph_and_async_warmup(self):
         root = Path(__file__).parents[1]
         for config_name in ("transformers-ja.yml", "transformers-ja-job.yml"):