From a90a5cba08fdf6c0ceb95101c275108a152a3aed Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 12 Jun 2024 07:35:37 +0200 Subject: Merging upstream version 127.0. Signed-off-by: Daniel Baumann --- toolkit/components/ml/docs/index.rst | 47 ++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 toolkit/components/ml/docs/index.rst (limited to 'toolkit/components/ml/docs/index.rst') diff --git a/toolkit/components/ml/docs/index.rst b/toolkit/components/ml/docs/index.rst new file mode 100644 index 0000000000..a171a982a3 --- /dev/null +++ b/toolkit/components/ml/docs/index.rst @@ -0,0 +1,47 @@ +Machine Learning +================ + +This component is an experimental machine learning local inference engine based on +Transformers.js and the ONNX runtime. + +In the example below, an image is converted to text using the `image-to-text` task. + + +.. code-block:: javascript + + const {PipelineOptions, EngineProcess } = ChromeUtils.importESModule("chrome://global/content/ml/EngineProcess.sys.mjs"); + + // First we create a pipeline options object, which contains the task name + // and any other options needed for the task + const options = new PipelineOptions({taskName: "image-to-text" }); + + // Next, we create an engine parent object via EngineProcess + const engineParent = await EngineProcess.getMLEngineParent(); + + // We then create the engine object, using the options + const engine = engineParent.getEngine(options); + + // At this point we are ready to do some inference. + + // We need to get the image as an array buffer and wrap it into a request object + const response = await fetch("https://huggingface.co/datasets/mishig/sample_images/resolve/main/football-match.jpg"); + const buffer = await response.arrayBuffer(); + const mimeType = response.headers.get('Content-Type'); + const request = { + data: buffer, + mimeType: mimeType + }; + + // Finally, we run the engine with the request object + const res = await engine.run(request); + + // The result is a string containing the text extracted from the image + console.log(res); + + +Supported Inference Tasks +::::::::::::::::::::::::: + +The following tasks are supported by the machine learning engine: + +.. js:autofunction:: imageToText -- cgit v1.2.3