Release Mark v0.1.0: 38.7M parameter multilingual diacritics (INT8/FP16/FP32/CoreML)

README.md

@@ -145,6 +145,20 @@ Held-out evaluation report across all 37 languages:
 
 ## Install & Integration
 
+### Python (ONNX Runtime)
+
+```python
+from mark import restore
+
+# Standard inference
+restored = restore("Omode naa n kawe daadaa ni ile-iwe.", lang="yo")
+# -> "Ọmọdé náà ń kàwé dáadáa ní ilé-ìwé."
+
+# Calibrated anti-flicker mode for streaming keyboard input (margin >= 0.4)
+stable = restore("El nino comio jamon en la manana.", lang="es", margin=0.4)
+# -> "El niño comió jamón en la mañana."
+```
+
 ### iOS / macOS (Swift Package Manager)
 
 Add to your `Package.swift`:
@@ -169,15 +183,15 @@ import Mark
 let mark = try Mark()
 
 // Yorùbá
-let yoruba = try await mark.restore("Omode naa n kawe daadaa ni ile-iwe.", lang: "yo")
+let yoruba = try mark.restore("Omode naa n kawe daadaa ni ile-iwe.", lang: "yo")
 // -> "Ọmọdé náà ń kàwé dáadáa ní ilé-ìwé."
 
 // Arabic
-let arabic = try await mark.restore("ذهب الولد الى المدرسة", lang: "ar")
-// -> "ذْهَبَ الْوَلَدُ إِلَى الْمَدْرَسَةِ"
+let arabic = try mark.restore("ذهب الولد الى المدرسة", lang: "ar")
+// -> "ذْهَبَ الْوَلَدُ إلَى الْمَدْرَسَةِ"
 
-// Spanish
-let spanish = try await mark.restore("El nino comio jamon en la manana.", lang: "es")
+// Spanish (with calibrated margin: 0.4 for zero typing jitter)
+let spanish = try mark.restore("El nino comio jamon en la manana.", lang: "es", margin: 0.4)
 // -> "El niño comió jamón en la mañana."
 ```
 
@@ -199,12 +213,12 @@ const yoruba = await restore("Omode naa n kawe daadaa ni ile-iwe.", "yo");
 // -> Ọmọdé náà ń kàwé dáadáa ní ilé-ìwé.
 
 const arabic = await restore("ذهب الولد الى المدرسة", "ar");
-// -> ذْهَبَ الْوَلَدُ إِلَى الْمَدْرَسَةِ
+// -> ذْهَبَ الْوَلَدُ إلَى الْمَدْرَسَةِ
 
-// Reusable instance
+// Reusable instance with calibrated anti-flicker margin
 const mark = new Mark();
 await mark.init();
-const spanish = await mark.restore("El nino comio jamon en la manana.", "es");
+const spanish = await mark.restore("El nino comio jamon en la manana.", "es", { margin: 0.4 });
 // -> El niño comió jamón en la mañana.
 ```
 

Sources/Mark/Mark.swift

@@ -84,7 +84,13 @@ public actor Mark {
     }
 
     /// Restore diacritics and tones on arbitrary input text.
-    public func restore(_ text: String, lang: String) throws -> String {
+    ///
+    /// - Parameters:
+    ///   - text: Raw unmarked input string.
+    ///   - lang: Target ISO 639-1 language code (e.g. "yo", "ar", "es").
+    ///   - margin: Confidence threshold over KEEP (default: 0.0). When set to 0.4+,
+    ///     suppresses hypothesis flicker during streaming keyboard input.
+    public func restore(_ text: String, lang: String, margin: Float = 0.0) throws -> String {
         guard !text.isEmpty else { return "" }
 
         let normalizedLang = lang.trimmingCharacters(in: .whitespacesAndNewlines).lowercased()
@@ -96,7 +102,7 @@ public actor Mark {
         var restoredChunks: [String] = []
 
         for chunk in chunks {
-            let restored = try restoreChunk(chunk, langId: langId)
+            let restored = try restoreChunk(chunk, langId: langId, margin: margin)
             restoredChunks.append(restored)
         }
 
@@ -104,7 +110,7 @@ public actor Mark {
     }
 
     /// Single chunk restoration (under 512 bytes) using MLShapedArray.
-    private func restoreChunk(_ chunk: String, langId: Int) throws -> String {
+    private func restoreChunk(_ chunk: String, langId: Int, margin: Float = 0.0) throws -> String {
         let utf8Bytes = Array(chunk.utf8)
         guard !utf8Bytes.isEmpty else { return "" }
 
@@ -133,19 +139,33 @@ public actor Mark {
         var preds: [Int] = []
         preds.reserveCapacity(seqLen)
 
-        // Fast contiguous scalar access for argmax
+        // Fast contiguous scalar access for calibrated margin or argmax
         for pos in 0..<seqLen {
             let offset = pos * numTags
-            var maxVal = -Float.infinity
-            var maxIdx = 0
-            for tagIdx in 0..<numTags {
-                let val = scalars[offset + tagIdx]
-                if val > maxVal {
-                    maxVal = val
-                    maxIdx = tagIdx
+            if margin > 0.0 && numTags > 1 {
+                let keepVal = scalars[offset + 0]
+                var bestVal = -Float.infinity
+                var bestIdx = 0
+                for tagIdx in 1..<numTags {
+                    let val = scalars[offset + tagIdx]
+                    if val > bestVal {
+                        bestVal = val
+                        bestIdx = tagIdx
+                    }
+                }
+                preds.append((bestVal - keepVal >= margin) ? bestIdx : 0)
+            } else {
+                var maxVal = -Float.infinity
+                var maxIdx = 0
+                for tagIdx in 0..<numTags {
+                    let val = scalars[offset + tagIdx]
+                    if val > maxVal {
+                        maxVal = val
+                        maxIdx = tagIdx
+                    }
                 }
+                preds.append(maxIdx)
             }
-            preds.append(maxIdx)
         }
 
         return decodePrediction(chunk: chunk, utf8Bytes: utf8Bytes, predTags: preds)