Update README.md
Browse files
README.md
CHANGED
@@ -1,199 +1,93 @@
|
|
1 |
---
|
2 |
-
|
3 |
-
|
|
|
|
|
|
|
|
|
4 |
---
|
5 |
|
6 |
-
# Model Card for Model ID
|
7 |
|
8 |
-
|
|
|
|
|
9 |
|
|
|
10 |
|
|
|
11 |
|
12 |
-
|
13 |
|
14 |
-
|
15 |
|
16 |
-
<!-- Provide a longer summary of what this model is. -->
|
17 |
|
18 |
-
|
19 |
|
20 |
-
-
|
21 |
-
- **Funded by [optional]:** [More Information Needed]
|
22 |
-
- **Shared by [optional]:** [More Information Needed]
|
23 |
-
- **Model type:** [More Information Needed]
|
24 |
-
- **Language(s) (NLP):** [More Information Needed]
|
25 |
-
- **License:** [More Information Needed]
|
26 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
27 |
|
28 |
-
|
29 |
|
30 |
-
|
31 |
|
32 |
-
-
|
33 |
-
-
|
34 |
-
- **Demo [optional]:** [More Information Needed]
|
35 |
|
36 |
-
|
37 |
|
38 |
-
|
|
|
|
|
39 |
|
40 |
-
|
41 |
|
42 |
-
|
|
|
43 |
|
44 |
-
|
|
|
45 |
|
46 |
-
### Downstream Use [optional]
|
47 |
|
48 |
-
|
|
|
49 |
|
50 |
-
[More Information Needed]
|
51 |
|
52 |
-
###
|
|
|
53 |
|
54 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
55 |
|
56 |
-
|
|
|
57 |
|
58 |
-
## Bias, Risks, and Limitations
|
59 |
|
60 |
-
|
|
|
|
|
|
|
61 |
|
62 |
-
[More Information Needed]
|
63 |
|
64 |
-
|
|
|
|
|
65 |
|
66 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
67 |
|
68 |
-
|
69 |
|
70 |
-
|
71 |
|
72 |
-
|
|
|
|
|
73 |
|
74 |
-
|
|
|
75 |
|
76 |
-
|
77 |
|
78 |
-
###
|
79 |
|
80 |
-
|
81 |
-
|
82 |
-
|
83 |
-
|
84 |
-
|
85 |
-
|
86 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
87 |
-
|
88 |
-
#### Preprocessing [optional]
|
89 |
-
|
90 |
-
[More Information Needed]
|
91 |
-
|
92 |
-
|
93 |
-
#### Training Hyperparameters
|
94 |
-
|
95 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
96 |
-
|
97 |
-
#### Speeds, Sizes, Times [optional]
|
98 |
-
|
99 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
100 |
-
|
101 |
-
[More Information Needed]
|
102 |
-
|
103 |
-
## Evaluation
|
104 |
-
|
105 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
106 |
-
|
107 |
-
### Testing Data, Factors & Metrics
|
108 |
-
|
109 |
-
#### Testing Data
|
110 |
-
|
111 |
-
<!-- This should link to a Dataset Card if possible. -->
|
112 |
-
|
113 |
-
[More Information Needed]
|
114 |
-
|
115 |
-
#### Factors
|
116 |
-
|
117 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
118 |
-
|
119 |
-
[More Information Needed]
|
120 |
-
|
121 |
-
#### Metrics
|
122 |
-
|
123 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
124 |
-
|
125 |
-
[More Information Needed]
|
126 |
-
|
127 |
-
### Results
|
128 |
-
|
129 |
-
[More Information Needed]
|
130 |
-
|
131 |
-
#### Summary
|
132 |
-
|
133 |
-
|
134 |
-
|
135 |
-
## Model Examination [optional]
|
136 |
-
|
137 |
-
<!-- Relevant interpretability work for the model goes here -->
|
138 |
-
|
139 |
-
[More Information Needed]
|
140 |
-
|
141 |
-
## Environmental Impact
|
142 |
-
|
143 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
144 |
-
|
145 |
-
Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
|
146 |
-
|
147 |
-
- **Hardware Type:** [More Information Needed]
|
148 |
-
- **Hours used:** [More Information Needed]
|
149 |
-
- **Cloud Provider:** [More Information Needed]
|
150 |
-
- **Compute Region:** [More Information Needed]
|
151 |
-
- **Carbon Emitted:** [More Information Needed]
|
152 |
-
|
153 |
-
## Technical Specifications [optional]
|
154 |
-
|
155 |
-
### Model Architecture and Objective
|
156 |
-
|
157 |
-
[More Information Needed]
|
158 |
-
|
159 |
-
### Compute Infrastructure
|
160 |
-
|
161 |
-
[More Information Needed]
|
162 |
-
|
163 |
-
#### Hardware
|
164 |
-
|
165 |
-
[More Information Needed]
|
166 |
-
|
167 |
-
#### Software
|
168 |
-
|
169 |
-
[More Information Needed]
|
170 |
-
|
171 |
-
## Citation [optional]
|
172 |
-
|
173 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
174 |
-
|
175 |
-
**BibTeX:**
|
176 |
-
|
177 |
-
[More Information Needed]
|
178 |
-
|
179 |
-
**APA:**
|
180 |
-
|
181 |
-
[More Information Needed]
|
182 |
-
|
183 |
-
## Glossary [optional]
|
184 |
-
|
185 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
186 |
-
|
187 |
-
[More Information Needed]
|
188 |
-
|
189 |
-
## More Information [optional]
|
190 |
-
|
191 |
-
[More Information Needed]
|
192 |
-
|
193 |
-
## Model Card Authors [optional]
|
194 |
-
|
195 |
-
[More Information Needed]
|
196 |
-
|
197 |
-
## Model Card Contact
|
198 |
-
|
199 |
-
[More Information Needed]
|
|
|
1 |
---
|
2 |
+
license: apache-2.0
|
3 |
+
language:
|
4 |
+
- en
|
5 |
+
base_model:
|
6 |
+
- meta-llama/Llama-3.2-3B-Instruct
|
7 |
+
pipeline_tag: text-generation
|
8 |
---
|
9 |
|
|
|
10 |
|
11 |
+
<div align="center">
|
12 |
+
<b style="font-size: 40px;">Gen-8B-R2</b>
|
13 |
+
</div>
|
14 |
|
15 |
+
Note: We are still working on this.
|
16 |
|
17 |
+
Are you looking for a more robust and reliable generation model for RAG system?
|
18 |
|
19 |
+
Here is a Gen-8B-R2 model that effectively mitigates hallucinations caused by retrieval noise and information overload.
|
20 |
|
21 |
+
See the details in our paper [Link](https://arxiv.org/pdf/2503.04789)
|
22 |
|
|
|
23 |
|
24 |
+
### What is Gen-8B-R2?
|
25 |
|
26 |
+
This model is one of the variant of Ext2Gen-8B-R2, which disables the process of extracting sentences from the chunk list.
|
|
|
|
|
|
|
|
|
|
|
|
|
27 |
|
28 |
+
See the details of Ext2Gen-8B-R2 in https://huggingface.co/DISLab/Ext2Gen-8B-R2
|
29 |
|
30 |
+
### Recommended Prompt
|
31 |
|
32 |
+
- query: the query to answer
|
33 |
+
- chunk_list: the list of retrieved chunks, e.g., ["chunk 1", "chunk 2", "chunk 3"]
|
|
|
34 |
|
35 |
+
```python
|
36 |
|
37 |
+
def prepare_sample_text(prompt):
|
38 |
+
row_json = [{"role": "user", "content": prompt}]
|
39 |
+
return tokenizer.apply_chat_template(row_json, tokenize=False)
|
40 |
|
41 |
+
def format_prompt_template(query, chunk_list):
|
42 |
|
43 |
+
chunk_list = ['[Chunk ID: '+ str(idx+1) + '] ' + chunk_text for idx, chunk_text in enumerate(chunk_list)]
|
44 |
+
chunk_list = '\n\n'.join(chunk_list)
|
45 |
|
46 |
+
prompt = '''
|
47 |
+
You are an expert assistant trained to generate answers based on document chunks.
|
48 |
|
|
|
49 |
|
50 |
+
### Generation Instruction:
|
51 |
+
- Answer to the Query based on the given Chunk List.
|
52 |
|
|
|
53 |
|
54 |
+
### Query:
|
55 |
+
%s
|
56 |
|
|
|
57 |
|
58 |
+
### Chunk List:
|
59 |
+
%s
|
60 |
|
|
|
61 |
|
62 |
+
### Output:
|
63 |
+
''' % (query, chunk_list)
|
64 |
+
|
65 |
+
return prompt.strip()
|
66 |
|
|
|
67 |
|
68 |
+
prompt = format_prompt_template(query, noisy_chunks)
|
69 |
+
prompt = prepare_sample_text(prompt)
|
70 |
+
```
|
71 |
|
|
|
72 |
|
73 |
+
Note that this prompt outputs both extracted relevant sentences and the answer to the query.
|
74 |
|
75 |
+
The output follows a consistent format as seen in an example below.
|
76 |
|
77 |
+
```
|
78 |
+
Extracted Sentences:
|
79 |
+
- The estimated number of deaths is 150-300,000, mainly Jews.
|
80 |
|
81 |
+
Answer: The estimated number of deaths at Chelmno is 150-300,000, mainly Jews.
|
82 |
+
```
|
83 |
|
84 |
+
The number of extracted sentences vary depending on the QA.
|
85 |
|
86 |
+
### Recommended Generation Parameters
|
87 |
|
88 |
+
```python
|
89 |
+
max_new_tokens=1024, # or 2048
|
90 |
+
do_sample=True,
|
91 |
+
temperature=0.8,
|
92 |
+
top_p=0.9,
|
93 |
+
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|