Xenova HF staff commited on
Commit
e3e5335
·
verified ·
1 Parent(s): 8262665

Update README.md

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