Update README.md
Browse files
README.md
CHANGED
@@ -4,4 +4,27 @@ library_name: "transformers.js"
|
|
4 |
|
5 |
https://huggingface.co/apple/mobilevit-x-small with ONNX weights to be compatible with Transformers.js.
|
6 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
7 |
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`).
|
|
|
4 |
|
5 |
https://huggingface.co/apple/mobilevit-x-small with ONNX weights to be compatible with Transformers.js.
|
6 |
|
7 |
+
## Usage (Transformers.js)
|
8 |
+
|
9 |
+
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/@xenova/transformers) using:
|
10 |
+
```bash
|
11 |
+
npm i @xenova/transformers
|
12 |
+
```
|
13 |
+
|
14 |
+
**Example:** Perform image classification with `Xenova/mobilevit-x-small`
|
15 |
+
```js
|
16 |
+
// Create an image classification pipeline
|
17 |
+
const classifier = await pipeline('image-classification', 'Xenova/mobilevit-x-small', {
|
18 |
+
quantized: false,
|
19 |
+
});
|
20 |
+
|
21 |
+
// Classify an image
|
22 |
+
const url = 'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/tiger.jpg';
|
23 |
+
const output = await classifier(url);
|
24 |
+
console.log(output);
|
25 |
+
// [{ label: 'tiger, Panthera tigris', score: 0.8842423558235168 }]
|
26 |
+
```
|
27 |
+
|
28 |
+
---
|
29 |
+
|
30 |
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`).
|