在 Android 上使用机器学习套件识别数字墨水

利用机器学习套件的数字墨水识别功能,您可以识别在数百种语言的数字表面上手写的文本,以及对草图进行分类。

  • 请试用示例应用,以查看此 API 的用法示例。

准备工作

  1. 请务必在您的项目级 build.gradle 文件中的 buildscriptallprojects 部分添加 Google 的 Maven 代码库。
  2. 将 Android 版机器学习套件库的依赖项添加到您的模块的应用级 Gradle 文件(通常为 app/build.gradle):
dependencies {
  // ...
  implementation 'com.google.mlkit:digital-ink-recognition:18.0.0'
}

您现在可以开始识别 Ink 对象中的文本了。

构建 Ink 对象

构建 Ink 对象的主要方法是在触摸屏上绘制该对象。在 Android 上,您可以使用 Canvas 实现此目的。您的触摸事件处理程序应调用以下代码段中所示的 addNewTouchEvent() 方法,以存储用户绘制到 Ink 对象中的描边点。

以下代码段对常规模式进行了演示。如需查看更完整的示例,请参阅机器学习套件快速入门示例

Kotlin

var inkBuilder = Ink.builder()
lateinit var strokeBuilder: Ink.Stroke.Builder

// Call this each time there is a new event.
fun addNewTouchEvent(event: MotionEvent) {
  val action = event.actionMasked
  val x = event.x
  val y = event.y
  var t = System.currentTimeMillis()

  // If your setup does not provide timing information, you can omit the
  // third paramater (t) in the calls to Ink.Point.create
  when (action) {
    MotionEvent.ACTION_DOWN -> {
      strokeBuilder = Ink.Stroke.builder()
      strokeBuilder.addPoint(Ink.Point.create(x, y, t))
    }
    MotionEvent.ACTION_MOVE -> strokeBuilder!!.addPoint(Ink.Point.create(x, y, t))
    MotionEvent.ACTION_UP -> {
      strokeBuilder.addPoint(Ink.Point.create(x, y, t))
      inkBuilder.addStroke(strokeBuilder.build())
    }
    else -> {
      // Action not relevant for ink construction
    }
  }
}

...

// This is what to send to the recognizer.
val ink = inkBuilder.build()

Java

Ink.Builder inkBuilder = Ink.builder();
Ink.Stroke.Builder strokeBuilder;

// Call this each time there is a new event.
public void addNewTouchEvent(MotionEvent event) {
  float x = event.getX();
  float y = event.getY();
  long t = System.currentTimeMillis();

  // If your setup does not provide timing information, you can omit the
  // third paramater (t) in the calls to Ink.Point.create
  int action = event.getActionMasked();
  switch (action) {
    case MotionEvent.ACTION_DOWN:
      strokeBuilder = Ink.Stroke.builder();
      strokeBuilder.addPoint(Ink.Point.create(x, y, t));
      break;
    case MotionEvent.ACTION_MOVE:
      strokeBuilder.addPoint(Ink.Point.create(x, y, t));
      break;
    case MotionEvent.ACTION_UP:
      strokeBuilder.addPoint(Ink.Point.create(x, y, t));
      inkBuilder.addStroke(strokeBuilder.build());
      strokeBuilder = null;
      break;
  }
}

...

// This is what to send to the recognizer.
Ink ink = inkBuilder.build();

获取 DigitalInkRecognizer 的实例

如需执行识别,请将 Ink 实例发送到 DigitalInkRecognizer 对象。以下代码显示了如何从 BCP-47 标记实例化此类识别器。

Kotlin

// Specify the recognition model for a language
var modelIdentifier: DigitalInkRecognitionModelIdentifier
try {
  modelIdentifier = DigitalInkRecognitionModelIdentifier.fromLanguageTag("en-US")
} catch (e: MlKitException) {
  // language tag failed to parse, handle error.
}
if (modelIdentifier == null) {
  // no model was found, handle error.
}
var model: DigitalInkRecognitionModel =
    DigitalInkRecognitionModel.builder(modelIdentifier).build()


// Get a recognizer for the language
var recognizer: DigitalInkRecognizer =
    DigitalInkRecognition.getClient(
        DigitalInkRecognizerOptions.builder(model).build())

Java

// Specify the recognition model for a language
DigitalInkRecognitionModelIdentifier modelIdentifier;
try {
  modelIdentifier =
    DigitalInkRecognitionModelIdentifier.fromLanguageTag("en-US");
} catch (MlKitException e) {
  // language tag failed to parse, handle error.
}
if (modelIdentifier == null) {
  // no model was found, handle error.
}

DigitalInkRecognitionModel model =
    DigitalInkRecognitionModel.builder(modelIdentifier).build();

// Get a recognizer for the language
DigitalInkRecognizer recognizer =
    DigitalInkRecognition.getClient(
        DigitalInkRecognizerOptions.builder(model).build());

处理 Ink 对象

Kotlin

recognizer.recognize(ink)
    .addOnSuccessListener { result: RecognitionResult ->
      // `result` contains the recognizer's answers as a RecognitionResult.
      // Logs the text from the top candidate.
      Log.i(TAG, result.candidates[0].text)
    }
    .addOnFailureListener { e: Exception ->
      Log.e(TAG, "Error during recognition: $e")
    }

Java

recognizer.recognize(ink)
    .addOnSuccessListener(
        // `result` contains the recognizer's answers as a RecognitionResult.
        // Logs the text from the top candidate.
        result -> Log.i(TAG, result.getCandidates().get(0).getText()))
    .addOnFailureListener(
        e -> Log.e(TAG, "Error during recognition: " + e));

上面的示例代码假定已下载识别模型,如下一部分中所述。

管理模型下载

尽管数字墨水识别 API 支持数百种语言,但每种语言都需要下载一些数据才能识别。每种语言大约需要 20MB 的存储空间。这由 RemoteModelManager 对象处理。

下载新模型

Kotlin

import com.google.mlkit.common.model.DownloadConditions
import com.google.mlkit.common.model.RemoteModelManager

var model: DigitalInkRecognitionModel =  ...
val remoteModelManager = RemoteModelManager.getInstance()

remoteModelManager.download(model, DownloadConditions.Builder().build())
    .addOnSuccessListener {
      Log.i(TAG, "Model downloaded")
    }
    .addOnFailureListener { e: Exception ->
      Log.e(TAG, "Error while downloading a model: $e")
    }

Java

import com.google.mlkit.common.model.DownloadConditions;
import com.google.mlkit.common.model.RemoteModelManager;

DigitalInkRecognitionModel model = ...;
RemoteModelManager remoteModelManager = RemoteModelManager.getInstance();

remoteModelManager
    .download(model, new DownloadConditions.Builder().build())
    .addOnSuccessListener(aVoid -> Log.i(TAG, "Model downloaded"))
    .addOnFailureListener(
        e -> Log.e(TAG, "Error while downloading a model: " + e));

检查模型是否已下载

Kotlin

var model: DigitalInkRecognitionModel =  ...
remoteModelManager.isModelDownloaded(model)

Java

DigitalInkRecognitionModel model = ...;
remoteModelManager.isModelDownloaded(model);

删除已下载的模型

从设备中移除模型会释放空间。

Kotlin

var model: DigitalInkRecognitionModel =  ...
remoteModelManager.deleteDownloadedModel(model)
    .addOnSuccessListener {
      Log.i(TAG, "Model successfully deleted")
    }
    .addOnFailureListener { e: Exception ->
      Log.e(TAG, "Error while deleting a model: $e")
    }

Java

DigitalInkRecognitionModel model = ...;
remoteModelManager.deleteDownloadedModel(model)
                  .addOnSuccessListener(
                      aVoid -> Log.i(TAG, "Model successfully deleted"))
                  .addOnFailureListener(
                      e -> Log.e(TAG, "Error while deleting a model: " + e));

提高文本识别准确性的提示

文字识别的准确性可能会因语言而异。准确性还取决于写作风格。虽然数字墨水识别经过训练,可以处理多种书写样式,但结果可能会因用户而异。

下面是一些提高文本识别器准确性的方法。请注意,这些技巧不适用于表情符号、自动绘制和形状的绘图分类器。

书写区域

许多应用都具有明确定义的用户输入区域。符号的含义部分取决于其大小相对于包含该符号的写入区域的大小。例如,小写或大写的字母“o”或“c”与逗号、正斜线之间的区别。

告知识别器写入区域的宽度和高度可提高准确性。不过,识别器会假定写入区域只包含一行文本。如果物理写入区域足够大,可以容纳两行或更多行用户,那么您可以通过传入具有最高单行文本高度估算值的 WriterArea 区域,获得更出色的效果。您传递给识别器的 WriterArea 对象不必与屏幕上的物理写入区域完全一致。在某些语言中,以这种方式更改 WriterArea 高度的效果更好。

指定书写区域时,指定其宽度和高度与描边坐标的单位相同。x,y 坐标参数没有单位单位,API 会对所有单位进行归一化,因此唯一重要的是描边的相对大小和位置。您可以随意传入适合您系统的任何缩放比例。

前提

上下文是您尝试识别的 Ink 中紧跟在描边之前的文本。您可以通过告知识别器前置上下文来帮助识别器。

例如,手写字母“n”和“u”经常被误认为是彼此所为。如果用户已输入不完整的字词“arg”,他们可能会继续被视为“ument”或“nment”的笔画。{0}{/1}指定前置上下文“arg”会消除歧义,因为“参数”一词更有可能是“argnment”。

前置上下文还有助于识别器识别字词间的间隔,即字词之间的空格。您可以输入空格字符,但不能绘制字符,因此识别器如何确定一个字词何时结束以及下一个字词何时开始?如果用户已撰写“hello”并继续输入书面字词“world”,则在没有前置上下文的情况下,识别程序会返回字符串“world”。不过,如果您指定前置上下文“hello world”,则模型会返回字符串“world”并提供前导空格,因为“hello world”比“helloword”更有意义。

您应提供最长的上下文前字符串,最多包含 20 个字符(包括空格)。如果字符串较长,识别器将只使用最后 20 个字符。

以下代码示例展示了如何定义写入区域并使用 RecognitionContext 对象指定前置上下文。

Kotlin

var preContext : String = ...;
var width : Float = ...;
var height : Float = ...;
val recognitionContext : RecognitionContext =
    RecognitionContext.builder()
        .setPreContext(preContext)
        .setWritingArea(WritingArea(width, height))
        .build()

recognizer.recognize(ink, recognitionContext)

Java

String preContext = ...;
float width = ...;
float height = ...;
RecognitionContext recognitionContext =
    RecognitionContext.builder()
                      .setPreContext(preContext)
                      .setWritingArea(new WritingArea(width, height))
                      .build();

recognizer.recognize(ink, recognitionContext);

描边顺序

识别准确率对笔画的顺序敏感。识别程序预计会按照人们的自然书写顺序进行笔画;例如,从左到右表示英语。任何与此模式不同的情况(例如从最后一个单词开始写一个英文句子)都会产生不太准确的结果。

另一个例子是移除 Ink 中间的一个单词并将其替换为另一个单词。修订版本可能位于句子的中间,但笔划的笔触位于笔触序列的末尾。在这种情况下,我们建议您将新写入的单词单独发送到 API,并使用您自己的逻辑将结果与之前的识别结果合并。

处理不明确的形状

在某些情况下,提供给识别器的形状的含义不明确。例如,边缘非常圆的矩形可以视为矩形或椭圆形。

这些不明确的支持请求可以通过使用识别分数来处理(如果可用)。只有形状分类器提供得分。如果模型非常有信心,则最高结果的得分将远高于次优的结果。如果不确定,前两个结果的得分将接近。另请注意,形状分类器会将整个 Ink 解释为一个形状。例如,如果 Ink 包含彼此相邻的矩形和椭圆形,则识别器可能会返回其中一个(或完全不同的内容),因为单个识别候选项无法表示两个形状。