Xenova HF staff commited on
Commit
0303fa0
·
verified ·
1 Parent(s): 5bf383b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +23 -0
README.md CHANGED
@@ -8,4 +8,27 @@ license: apache-2.0
8
 
9
  https://huggingface.co/timm/mobilenetv4_conv_small.e2400_r224_in1k with ONNX weights to be compatible with Transformers.js.
10
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  Note: Having a separate repo for ONNX weights is intended to be a temporary solution until WebML gains more traction. If you would like to make your models web-ready, we recommend converting to ONNX using [🤗 Optimum](https://huggingface.co/docs/optimum/index) and structuring your repo like this one (with ONNX weights located in a subfolder named `onnx`).
 
8
 
9
  https://huggingface.co/timm/mobilenetv4_conv_small.e2400_r224_in1k with ONNX weights to be compatible with Transformers.js.
10
 
11
+ ## Usage (Transformers.js)
12
+
13
+ If you haven't already, you can install the [Transformers.js](https://huggingface.co/docs/transformers.js) JavaScript library from [NPM](https://www.npmjs.com/package/@huggingface/transformers) using:
14
+ ```bash
15
+ npm i @huggingface/transformers
16
+ ```
17
+
18
+ **Example:** Perform image classification with `onnx-community/mobilenetv4s-webnn`
19
+
20
+ ```js
21
+ import { pipeline } from '@huggingface/transformers';
22
+
23
+ // Create an image classification pipeline
24
+ const classifier = await pipeline('image-classification', 'onnx-community/mobilenetv4s-webnn');
25
+
26
+ // Classify an image
27
+ const url = 'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/tiger.jpg';
28
+ const output = await classifier(url);
29
+ // [{ label: 'tiger, Panthera tigris', score: 0.903573540929381 }]
30
+ ```
31
+
32
+ ---
33
+
34
  Note: Having a separate repo for ONNX weights is intended to be a temporary solution until WebML gains more traction. If you would like to make your models web-ready, we recommend converting to ONNX using [🤗 Optimum](https://huggingface.co/docs/optimum/index) and structuring your repo like this one (with ONNX weights located in a subfolder named `onnx`).