guihu commited on
Commit
d6c1804
·
verified ·
1 Parent(s): f94cee6

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
  [`google/gemma-3-4b-it`](https://huggingface.co/google/gemma-3-4b-it); 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
 
@@ -120,9 +118,7 @@ print(processor.decode(generated, skip_special_tokens=True))
120
 
121
  ## vLLM
122
 
123
- The reference vLLM environment uses NVIDIA H100 hardware and the pinned versions
124
- listed in `requirements.txt`. Other recent CUDA GPUs may also work, but are treated
125
- as best-effort environments and should be recorded in the smoke-test report.
126
 
127
  ```python
128
  from huggingface_hub import snapshot_download
@@ -152,16 +148,10 @@ print(outputs[0].outputs[0].text)
152
 
153
  ## Reproducibility
154
 
155
- - Adapter SHA-256 and sanitized training hyperparameters: `training_manifest.json`
156
- - Frozen inputs and reference outputs: `smoke_test.json`
157
- - Paper: [https://openreview.net/forum?id=t1037gQHuf](https://openreview.net/forum?id=t1037gQHuf)
158
  - Code: [https://github.com/guihuzhang/xqdt](https://github.com/guihuzhang/xqdt)
159
 
160
- The original training run did not freeze a public Hugging Face revision for every
161
- base model. The standard base-model ID above replaces the machine-local cache path
162
- stored by the training framework. Users must comply with the corresponding base
163
- model's access terms and license.
164
-
165
  ## Citation
166
 
167
  ```bibtex
 
21
  [`google/gemma-3-4b-it`](https://huggingface.co/google/gemma-3-4b-it); 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
 
 
118
 
119
  ## vLLM
120
 
121
+ Install the versions listed in `requirements.txt` before running this example.
 
 
122
 
123
  ```python
124
  from huggingface_hub import snapshot_download
 
148
 
149
  ## Reproducibility
150
 
151
+ - Training configuration: `training_manifest.json`
152
+ - Example inputs and outputs: `smoke_test.json`
 
153
  - Code: [https://github.com/guihuzhang/xqdt](https://github.com/guihuzhang/xqdt)
154
 
 
 
 
 
 
155
  ## Citation
156
 
157
  ```bibtex