Xenova HF staff commited on
Commit
4f196f1
·
verified ·
1 Parent(s): b775709

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +35 -0
README.md CHANGED
@@ -5,4 +5,39 @@ base_model: THUDM/glm-edge-1.5b-chat
5
 
6
  https://huggingface.co/THUDM/glm-edge-1.5b-chat with ONNX weights to be compatible with Transformers.js.
7
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  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`).
 
5
 
6
  https://huggingface.co/THUDM/glm-edge-1.5b-chat with ONNX weights to be compatible with Transformers.js.
7
 
8
+
9
+ ## Usage (Transformers.js)
10
+
11
+ 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:
12
+ ```bash
13
+ npm i @huggingface/transformers
14
+ ```
15
+
16
+
17
+ **Example:** Text-generation w/ `onnx-community/glm-edge-1.5b-chat-ONNX`
18
+ ```js
19
+ import { pipeline } from "@huggingface/transformers";
20
+
21
+ // Create a text generation pipeline
22
+ const generator = await pipeline(
23
+ "text-generation",
24
+ "onnx-community/glm-edge-1.5b-chat-ONNX",
25
+ { dtype: "q4" },
26
+ );
27
+
28
+ // Define the list of messages
29
+ const messages = [
30
+ { role: "system", content: "You are a helpful assistant." },
31
+ { role: "user", content: "Tell me a joke." },
32
+ ];
33
+
34
+ // Generate a response
35
+ const output = await generator(messages, { max_new_tokens: 128 });
36
+ console.log(output[0].generated_text.at(-1).content);
37
+ // "Why don't scientists trust atoms?\n\nBecause they make up everything!"
38
+ ```
39
+
40
+
41
+ ---
42
+
43
  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`).