Xenova HF staff commited on
Commit
0b6a458
1 Parent(s): 017ee87

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +25 -0
README.md CHANGED
@@ -4,4 +4,29 @@ library_name: transformers.js
4
 
5
  https://huggingface.co/stabilityai/stablelm-2-1_6b 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/stabilityai/stablelm-2-1_6b with ONNX weights to be compatible with Transformers.js.
6
 
7
+
8
+ ## Usage (Transformers.js)
9
+
10
+ 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:
11
+ ```bash
12
+ npm i @xenova/transformers
13
+ ```
14
+
15
+ **Example:** Text generation with `Xenova/stablelm-2-1_6b`.
16
+
17
+ ```js
18
+ import { pipeline } from '@xenova/transformers';
19
+
20
+ // Create text generation pipeline
21
+ const generator = await pipeline('text-generation', 'Xenova/stablelm-2-1_6b');
22
+
23
+ // Generate text
24
+ const output = await generator('The weather is always wonderful', { max_new_tokens: 20 });
25
+ console.log(output[0].generated_text);
26
+ // The weather is always wonderful when you are in the country. The sun is always shining, and you can always see the mountains
27
+ ```
28
+
29
+ ---
30
+
31
+
32
  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`).