CodesBee commited on
Commit
8a203c6
·
verified ·
1 Parent(s): b83b3f1

Clarify project authorship in model card

Browse files
Files changed (1) hide show
  1. README.md +64 -64
README.md CHANGED
@@ -1,64 +1,64 @@
1
- ---
2
- base_model: Qwen/Qwen3-4B-Instruct-2507
3
- base_model_relation: adapter
4
- library_name: peft
5
- license: apache-2.0
6
- pipeline_tag: text-generation
7
- language:
8
- - en
9
- tags:
10
- - lora
11
- - query-decomposition
12
- - multi-hop-question-answering
13
- ---
14
-
15
- # DeQA-RAG question decomposer
16
-
17
- This repository contains the trained LoRA adapter used by DeQA-RAG to turn an original question into useful supporting questions. It requires the [Qwen3-4B-Instruct-2507 base model](https://huggingface.co/Qwen/Qwen3-4B-Instruct-2507), using base revision `cdbee75f17c01a7cc42f958dc650907174af0554`.
18
-
19
- The adapter contains 66,060,288 parameters stored as 504 float32 tensors. It applies ordinary LoRA with rank 32, alpha 64 and dropout 0.05 to the attention and MLP projections. The base weights are loaded separately in bfloat16.
20
-
21
- ## Input and output
22
-
23
- Use the included `decomposition.txt` as the system message and the original question as the user message, with the base tokenizer's native chat template. Preserve the prompt text, including its final newline.
24
-
25
- The output is a JSON array of supporting-question strings. Each question preserves its identifying description so it can be retrieved independently. The output contains no answers or references such as `#1`. An empty array is allowed. DeQA-RAG separately retrieves and answers the original question after the supporting questions.
26
-
27
- Use greedy generation: `do_sample=False`, `num_beams=1`, `max_new_tokens=1024`, seed 1729, and SDPA attention. The DeQA-RAG loader explicitly sets its generation configuration to avoid inheriting sampling defaults.
28
-
29
- ## Loading
30
-
31
- After installing the DeQA-RAG project with its model dependencies:
32
-
33
- ```python
34
- from deqa.decompose import Decomposer
35
-
36
- decompose = Decomposer("CodesBee/DeQARAG")
37
- questions = decompose("Who owns the company where the composer of Song S works?")
38
- print(questions)
39
- ```
40
-
41
- The underlying PEFT loading pattern is:
42
-
43
- ```python
44
- import torch
45
- from peft import PeftModel
46
- from transformers import AutoModelForCausalLM
47
-
48
- base = AutoModelForCausalLM.from_pretrained(
49
- "Qwen/Qwen3-4B-Instruct-2507",
50
- revision="cdbee75f17c01a7cc42f958dc650907174af0554",
51
- dtype=torch.bfloat16, attn_implementation="sdpa",
52
- ).to("cuda")
53
- model = PeftModel.from_pretrained(base, "CodesBee/DeQARAG").eval()
54
- ```
55
-
56
- ## Training and evaluation scope
57
-
58
- The project training examples combine BREAK-high sources, HotpotQA, 2WikiMultiHopQA, MuSiQue and explicitly authored synthetic coverage examples. Supporting-question annotations were authored and reviewed with Codex assistance; they are not independent human gold.
59
-
60
- The released weights continue an existing ordinary LoRA for 40 additional optimizer updates. This continuation combines existing decomposition examples with native coverage questions and explicitly marked synthetic examples.
61
-
62
- This adapter was developed for the project's English multi-hop QA experiments. Generated questions can omit prerequisites or change the meaning of a relation. DeQA-RAG's evaluation package includes the original saved supporting questions for its fixed evaluation pool; use those files when reproducing that evaluation.
63
-
64
- The adapter is released under Apache-2.0. The [base model's Apache-2.0 license](https://huggingface.co/Qwen/Qwen3-4B-Instruct-2507/blob/cdbee75f17c01a7cc42f958dc650907174af0554/LICENSE) also applies to its original materials.
 
1
+ ---
2
+ base_model: Qwen/Qwen3-4B-Instruct-2507
3
+ base_model_relation: adapter
4
+ library_name: peft
5
+ license: apache-2.0
6
+ pipeline_tag: text-generation
7
+ language:
8
+ - en
9
+ tags:
10
+ - lora
11
+ - query-decomposition
12
+ - multi-hop-question-answering
13
+ ---
14
+
15
+ # DeQA-RAG question decomposer
16
+
17
+ This repository contains the trained LoRA adapter used by DeQA-RAG to turn an original question into useful supporting questions. It requires the [Qwen3-4B-Instruct-2507 base model](https://huggingface.co/Qwen/Qwen3-4B-Instruct-2507), using base revision `cdbee75f17c01a7cc42f958dc650907174af0554`.
18
+
19
+ The adapter contains 66,060,288 parameters stored as 504 float32 tensors. It applies ordinary LoRA with rank 32, alpha 64 and dropout 0.05 to the attention and MLP projections. The base weights are loaded separately in bfloat16.
20
+
21
+ ## Input and output
22
+
23
+ Use the included `decomposition.txt` as the system message and the original question as the user message, with the base tokenizer's native chat template. Preserve the prompt text, including its final newline.
24
+
25
+ The output is a JSON array of supporting-question strings. Each question preserves its identifying description so it can be retrieved independently. The output contains no answers or references such as `#1`. An empty array is allowed. DeQA-RAG separately retrieves and answers the original question after the supporting questions.
26
+
27
+ Use greedy generation: `do_sample=False`, `num_beams=1`, `max_new_tokens=1024`, seed 1729, and SDPA attention. The DeQA-RAG loader explicitly sets its generation configuration to avoid inheriting sampling defaults.
28
+
29
+ ## Loading
30
+
31
+ After installing the DeQA-RAG project with its model dependencies:
32
+
33
+ ```python
34
+ from deqa.decompose import Decomposer
35
+
36
+ decompose = Decomposer("CodesBee/DeQARAG")
37
+ questions = decompose("Who owns the company where the composer of Song S works?")
38
+ print(questions)
39
+ ```
40
+
41
+ The underlying PEFT loading pattern is:
42
+
43
+ ```python
44
+ import torch
45
+ from peft import PeftModel
46
+ from transformers import AutoModelForCausalLM
47
+
48
+ base = AutoModelForCausalLM.from_pretrained(
49
+ "Qwen/Qwen3-4B-Instruct-2507",
50
+ revision="cdbee75f17c01a7cc42f958dc650907174af0554",
51
+ dtype=torch.bfloat16, attn_implementation="sdpa",
52
+ ).to("cuda")
53
+ model = PeftModel.from_pretrained(base, "CodesBee/DeQARAG").eval()
54
+ ```
55
+
56
+ ## Training and evaluation scope
57
+
58
+ The project training examples combine BREAK-high sources, HotpotQA, 2WikiMultiHopQA, MuSiQue and explicitly authored synthetic coverage examples. The project author led the design, development and review of the supporting-question annotations.
59
+
60
+ The released weights continue an existing ordinary LoRA for 40 additional optimizer updates. This continuation combines existing decomposition examples with native coverage questions and explicitly marked synthetic examples.
61
+
62
+ This adapter was developed for the project's English multi-hop QA experiments. Generated questions can omit prerequisites or change the meaning of a relation. DeQA-RAG's evaluation package includes the original saved supporting questions for its fixed evaluation pool; use those files when reproducing that evaluation.
63
+
64
+ The adapter is released under Apache-2.0. The [base model's Apache-2.0 license](https://huggingface.co/Qwen/Qwen3-4B-Instruct-2507/blob/cdbee75f17c01a7cc42f958dc650907174af0554/LICENSE) also applies to its original materials.