Xenova HF Staff commited on
Commit
b9413fb
·
verified ·
1 Parent(s): 48b37ec

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +43 -1
README.md CHANGED
@@ -4,4 +4,46 @@ base_model:
4
  - EssentialAI/rnj-1-instruct
5
  pipeline_tag: text-generation
6
  library_name: transformers.js
7
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
  - EssentialAI/rnj-1-instruct
5
  pipeline_tag: text-generation
6
  library_name: transformers.js
7
+ ---
8
+
9
+
10
+ ### use with Transformers.js
11
+
12
+ > [!IMPORTANT]
13
+ > Note: This model requires Transformers.js v4.0.0 and above!
14
+
15
+ 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:
16
+ ```bash
17
+ npm i @huggingface/transformers
18
+ ```
19
+
20
+ **Example**: Basic example
21
+
22
+ ```js
23
+ import { pipeline, TextStreamer } from "@huggingface/transformers";
24
+
25
+ // Create a text generation pipeline
26
+ const generator = await pipeline(
27
+ "text-generation",
28
+ "onnx-community/rnj-1-instruct-ONNX",
29
+ {
30
+ device: "webgpu",
31
+ dtype: "q4f16",
32
+ },
33
+ );
34
+
35
+ // Define the list of messages
36
+ const messages = [
37
+ { role: "system", content: "You are a helpful assistant." },
38
+ { role: "user", content: "What is the capital of France?" },
39
+ ];
40
+
41
+ // Generate a response
42
+ const output = await generator(messages, {
43
+ max_new_tokens: 512,
44
+ do_sample: false,
45
+ streamer: new TextStreamer(generator.tokenizer, { skip_prompt: true, skip_special_tokens: true }),
46
+ });
47
+ console.log(output[0].generated_text.at(-1).content);
48
+ // The capital of France is Paris.
49
+ ```