guihu commited on
Commit
b9fa828
·
verified ·
1 Parent(s): 6b66479

Refine model card

Browse files
Files changed (1) hide show
  1. README.md +9 -19
README.md CHANGED
@@ -21,7 +21,7 @@ Metric with Feedback Signals*. The base model is
21
  [`Qwen/Qwen3-8B`](https://huggingface.co/Qwen/Qwen3-8B); base-model
22
  weights are not included here.
23
 
24
- This checkpoint corresponds to the paper's E2E setting and was trained on the joint WebNLG--E2E synthetic training set; the short repository name does not mean E2E-only training.
25
 
26
  ## Intended use
27
 
@@ -31,9 +31,8 @@ terminology, `missing` identifies an input unit omitted from the text; `extra`
31
  identifies text content unsupported by the input; and `incorrect` identifies an
32
  input unit realised with incorrect information.
33
 
34
- The expected prompt and four frozen regression examples are provided in
35
- `smoke_test.json`. This model is an evaluation component, not a general-purpose
36
- fact checker, and has not been validated outside data--text alignment settings.
37
 
38
  ## Prompt format
39
 
@@ -45,10 +44,9 @@ TRIPLES:
45
  Output as markdown table with Type and Triple columns.
46
  ```
47
 
48
- The canonical paper implementation uses **ms-swift PtEngine**. Transformers and
49
- vLLM are provided as portable alternatives. Different libraries, versions, and
50
- sampling implementations can produce small output differences; compare parsed
51
- error units rather than requiring byte-identical text.
52
 
53
  ## ms-swift PtEngine
54
 
@@ -122,9 +120,7 @@ print(tokenizer.decode(generated, skip_special_tokens=True))
122
 
123
  ## vLLM
124
 
125
- The reference vLLM environment uses NVIDIA H100 hardware and the pinned versions
126
- listed in `requirements.txt`. Other recent CUDA GPUs may also work, but are treated
127
- as best-effort environments and should be recorded in the smoke-test report.
128
 
129
  ```python
130
  from huggingface_hub import snapshot_download
@@ -154,16 +150,10 @@ print(outputs[0].outputs[0].text)
154
 
155
  ## Reproducibility
156
 
157
- - Adapter SHA-256 and sanitized training hyperparameters: `training_manifest.json`
158
- - Frozen inputs and reference outputs: `smoke_test.json`
159
- - Paper: [https://openreview.net/forum?id=t1037gQHuf](https://openreview.net/forum?id=t1037gQHuf)
160
  - Code: [https://github.com/guihuzhang/xqdt](https://github.com/guihuzhang/xqdt)
161
 
162
- The original training run did not freeze a public Hugging Face revision for every
163
- base model. The standard base-model ID above replaces the machine-local cache path
164
- stored by the training framework. Users must comply with the corresponding base
165
- model's access terms and license.
166
-
167
  ## Citation
168
 
169
  ```bibtex
 
21
  [`Qwen/Qwen3-8B`](https://huggingface.co/Qwen/Qwen3-8B); base-model
22
  weights are not included here.
23
 
24
+ This E2E checkpoint was trained on the joint WebNLG--E2E synthetic training set.
25
 
26
  ## Intended use
27
 
 
31
  identifies text content unsupported by the input; and `incorrect` identifies an
32
  input unit realised with incorrect information.
33
 
34
+ The expected prompt and four example inputs and outputs are provided in
35
+ `smoke_test.json`.
 
36
 
37
  ## Prompt format
38
 
 
44
  Output as markdown table with Type and Triple columns.
45
  ```
46
 
47
+ The canonical implementation uses **ms-swift PtEngine**. Transformers and vLLM
48
+ examples are also provided. Outputs may vary slightly across runtimes; evaluation
49
+ uses the parsed error units.
 
50
 
51
  ## ms-swift PtEngine
52
 
 
120
 
121
  ## vLLM
122
 
123
+ Install the versions listed in `requirements.txt` before running this example.
 
 
124
 
125
  ```python
126
  from huggingface_hub import snapshot_download
 
150
 
151
  ## Reproducibility
152
 
153
+ - Training configuration: `training_manifest.json`
154
+ - Example inputs and outputs: `smoke_test.json`
 
155
  - Code: [https://github.com/guihuzhang/xqdt](https://github.com/guihuzhang/xqdt)
156
 
 
 
 
 
 
157
  ## Citation
158
 
159
  ```bibtex