scientify 3.0.0 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.en.md +24 -6
- package/README.md +31 -6
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/dist/src/cli/research.d.ts.map +1 -1
- package/dist/src/cli/research.js +42 -1
- package/dist/src/cli/research.js.map +1 -1
- package/dist/src/commands.d.ts.map +1 -1
- package/dist/src/commands.js +159 -1
- package/dist/src/commands.js.map +1 -1
- package/dist/src/release-gate.d.ts +14 -0
- package/dist/src/release-gate.d.ts.map +1 -0
- package/dist/src/release-gate.js +124 -0
- package/dist/src/release-gate.js.map +1 -0
- package/dist/src/templates/bootstrap.d.ts.map +1 -1
- package/dist/src/templates/bootstrap.js +139 -62
- package/dist/src/templates/bootstrap.js.map +1 -1
- package/openclaw.plugin.json +9 -2
- package/package.json +10 -2
- package/skills/algorithm-selection/SKILL.md +103 -0
- package/skills/algorithm-selection/references/candidate-template.md +13 -0
- package/skills/algorithm-selection/references/selection-template.md +39 -0
- package/skills/artifact-review/SKILL.md +146 -0
- package/skills/artifact-review/references/release-gate-template.md +40 -0
- package/skills/artifact-review/references/review-checklist.md +45 -0
- package/skills/artifact-review/references/style-review-checklist.md +30 -0
- package/skills/baseline-runner/SKILL.md +103 -0
- package/skills/baseline-runner/references/baseline-matrix-template.md +9 -0
- package/skills/baseline-runner/references/baseline-report-template.md +25 -0
- package/skills/dataset-validate/SKILL.md +104 -0
- package/skills/dataset-validate/references/data-validation-template.md +38 -0
- package/skills/figure-standardize/SKILL.md +110 -0
- package/skills/figure-standardize/references/caption-template.md +12 -0
- package/skills/figure-standardize/references/figure-placement-template.md +30 -0
- package/skills/figure-standardize/references/figure-style-guide.md +36 -0
- package/skills/release-layout/SKILL.md +73 -0
- package/skills/release-layout/references/page-structure.md +14 -0
- package/skills/research-experiment/SKILL.md +10 -1
- package/skills/research-survey/SKILL.md +19 -2
- package/skills/write-paper/SKILL.md +252 -0
- package/skills/write-paper/references/boundary-notes-template.md +34 -0
- package/skills/write-paper/references/claim-inventory-template.md +32 -0
- package/skills/write-paper/references/evidence-contract.md +57 -0
- package/skills/write-paper/references/figure-callout-template.md +38 -0
- package/skills/write-paper/references/figures-manifest-template.md +44 -0
- package/skills/write-paper/references/latex/README.md +22 -0
- package/skills/write-paper/references/latex/build_paper.sh +41 -0
- package/skills/write-paper/references/latex/manuscript.tex +39 -0
- package/skills/write-paper/references/latex/references.bib +10 -0
- package/skills/write-paper/references/latex/sections/ablations.tex +3 -0
- package/skills/write-paper/references/latex/sections/abstract.tex +3 -0
- package/skills/write-paper/references/latex/sections/conclusion.tex +3 -0
- package/skills/write-paper/references/latex/sections/discussion_scope.tex +7 -0
- package/skills/write-paper/references/latex/sections/experimental_protocol.tex +3 -0
- package/skills/write-paper/references/latex/sections/introduction.tex +3 -0
- package/skills/write-paper/references/latex/sections/main_results.tex +9 -0
- package/skills/write-paper/references/latex/sections/method_system.tex +3 -0
- package/skills/write-paper/references/latex/sections/problem_setup.tex +3 -0
- package/skills/write-paper/references/latex/sections/related_work.tex +3 -0
- package/skills/write-paper/references/paper-template.md +155 -0
- package/skills/write-paper/references/paragraph-contract.md +139 -0
- package/skills/write-paper/references/paragraph-examples.md +171 -0
- package/skills/write-paper/references/style-banlist.md +81 -0
- package/skills/write-review-paper/SKILL.md +10 -4
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Figures Manifest Template
|
|
2
|
+
|
|
3
|
+
Use this structure for `paper/figures_manifest.md`.
|
|
4
|
+
|
|
5
|
+
This file is the single source of truth for how a figure supports claims, how it is introduced in prose, and how it should be rendered in LaTeX.
|
|
6
|
+
|
|
7
|
+
```yaml
|
|
8
|
+
- figure_id: "fig-kv2-tradeoff-overview"
|
|
9
|
+
file_path: "paper/figures/kv2_tradeoff_overview.pdf"
|
|
10
|
+
latex_label: "fig:kv2-tradeoff-overview"
|
|
11
|
+
section: "main_results"
|
|
12
|
+
placement_hint: "figure[t]"
|
|
13
|
+
caption_short: "KV2 versus INT4-FIFO and quant-family baselines under the simulator protocol."
|
|
14
|
+
caption_long: "KV2 improves TTFT relative to INT4-FIFO while preserving the stated quality guard. The figure compares the main tradeoff surface across the selected quant-family baselines under the shared simulator protocol."
|
|
15
|
+
takeaway_sentence: "KV2 improves TTFT relative to INT4-FIFO, but the strongest bytes-efficiency challenger remains KVQuant-3bit-1% under the same harness."
|
|
16
|
+
callout_sentence: "Figure \\ref{fig:kv2-tradeoff-overview} compares KV2 with INT4-FIFO and quant-family baselines under the shared simulator protocol."
|
|
17
|
+
baseline: "INT4-FIFO"
|
|
18
|
+
evidence_type: "simulator"
|
|
19
|
+
source_metrics:
|
|
20
|
+
- "mean_ttft_gain_vs_int4_pct"
|
|
21
|
+
- "mean_bytes_gain_vs_int4_pct"
|
|
22
|
+
source_files:
|
|
23
|
+
- "experiment_res.md"
|
|
24
|
+
- "Comparision-KV2/results/kv2_compare_quant_family_local_20260329.md"
|
|
25
|
+
supports_claim_ids:
|
|
26
|
+
- "claim-001"
|
|
27
|
+
- "claim-003"
|
|
28
|
+
must_appear_before_claim_ids:
|
|
29
|
+
- "claim-001"
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Rules:
|
|
33
|
+
|
|
34
|
+
- Use one entry per figure, not one entry per paragraph.
|
|
35
|
+
- `section` should name the manuscript module that owns the figure, such as `main_results`, `experimental_protocol`, or `ablations`.
|
|
36
|
+
- `placement_hint` must already be TeX-oriented, for example `figure[t]`, `figure[b]`, `figure* [t]`, or `inline_reference_only`.
|
|
37
|
+
- `caption_short` is for the optional short caption in `\caption[...]`.
|
|
38
|
+
- `caption_long` must include the scientific meaning, the comparison target, and the relevant scope or protocol note when needed.
|
|
39
|
+
- `takeaway_sentence` is the one-sentence interpretation the prose should not forget to make explicit.
|
|
40
|
+
- `callout_sentence` is the first sentence that should introduce the figure in the body text.
|
|
41
|
+
- `supports_claim_ids` lists which claims the figure directly supports.
|
|
42
|
+
- `must_appear_before_claim_ids` lists the claims that should not appear before the reader has seen or been introduced to this figure.
|
|
43
|
+
|
|
44
|
+
If a headline claim is table-only or text-only evidence, do not create a fake figure entry. Instead, say so explicitly in the results paragraph and keep the claim anchored to a table or source artifact.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# LaTeX Starter Bundle
|
|
2
|
+
|
|
3
|
+
This starter bundle is copied into `paper/` when a new research workspace is created.
|
|
4
|
+
|
|
5
|
+
It provides:
|
|
6
|
+
|
|
7
|
+
- `manuscript.tex` as the top-level entry point
|
|
8
|
+
- `sections/*.tex` for section-by-section drafting
|
|
9
|
+
- `references.bib` as the bibliography placeholder
|
|
10
|
+
- `build_paper.sh` to compile the PDF with `tectonic`
|
|
11
|
+
|
|
12
|
+
Expected outputs after running the build script:
|
|
13
|
+
|
|
14
|
+
- `paper/build/manuscript.pdf`
|
|
15
|
+
- `paper/build/build.log`
|
|
16
|
+
- `paper/build/build_errors.md` when compilation fails
|
|
17
|
+
|
|
18
|
+
Notes:
|
|
19
|
+
|
|
20
|
+
- The default bibliography commands in `manuscript.tex` are commented out to keep the first build path simple.
|
|
21
|
+
- Uncomment the bibliography lines after citations and BibTeX entries are ready.
|
|
22
|
+
- The starter bundle is modular. Keep the core sections, then selectively enable optional modules such as `related_work`, `ablations`, or `discussion_scope` when the paper shape actually needs them.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
set -euo pipefail
|
|
3
|
+
|
|
4
|
+
PAPER_DIR="$(cd "$(dirname "$0")" && pwd)"
|
|
5
|
+
BUILD_DIR="$PAPER_DIR/build"
|
|
6
|
+
LOG_PATH="$BUILD_DIR/build.log"
|
|
7
|
+
ERROR_PATH="$BUILD_DIR/build_errors.md"
|
|
8
|
+
|
|
9
|
+
mkdir -p "$BUILD_DIR"
|
|
10
|
+
|
|
11
|
+
if ! command -v tectonic >/dev/null 2>&1; then
|
|
12
|
+
cat >"$ERROR_PATH" <<'EOF'
|
|
13
|
+
# Paper Build Error
|
|
14
|
+
|
|
15
|
+
`tectonic` was not found in `PATH`.
|
|
16
|
+
|
|
17
|
+
Install `tectonic` first, then rerun:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
bash paper/build_paper.sh
|
|
21
|
+
```
|
|
22
|
+
EOF
|
|
23
|
+
exit 1
|
|
24
|
+
fi
|
|
25
|
+
|
|
26
|
+
cd "$PAPER_DIR"
|
|
27
|
+
|
|
28
|
+
if tectonic --outdir "$BUILD_DIR" manuscript.tex >"$LOG_PATH" 2>&1; then
|
|
29
|
+
rm -f "$ERROR_PATH"
|
|
30
|
+
else
|
|
31
|
+
{
|
|
32
|
+
echo "# Paper Build Error"
|
|
33
|
+
echo
|
|
34
|
+
echo "The LaTeX build failed. See \`paper/build/build.log\` for the full compiler output."
|
|
35
|
+
echo
|
|
36
|
+
echo '```text'
|
|
37
|
+
tail -n 80 "$LOG_PATH" || true
|
|
38
|
+
echo '```'
|
|
39
|
+
} >"$ERROR_PATH"
|
|
40
|
+
exit 1
|
|
41
|
+
fi
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
\documentclass[11pt]{article}
|
|
2
|
+
|
|
3
|
+
\usepackage[margin=1in]{geometry}
|
|
4
|
+
\usepackage[T1]{fontenc}
|
|
5
|
+
\usepackage[utf8]{inputenc}
|
|
6
|
+
\usepackage{microtype}
|
|
7
|
+
\usepackage{amsmath,amssymb}
|
|
8
|
+
\usepackage{booktabs}
|
|
9
|
+
\usepackage{graphicx}
|
|
10
|
+
\usepackage{xcolor}
|
|
11
|
+
\usepackage{hyperref}
|
|
12
|
+
|
|
13
|
+
\title{Paper Title Placeholder}
|
|
14
|
+
\author{Author Placeholder}
|
|
15
|
+
\date{}
|
|
16
|
+
|
|
17
|
+
\begin{document}
|
|
18
|
+
|
|
19
|
+
\maketitle
|
|
20
|
+
|
|
21
|
+
\input{sections/abstract}
|
|
22
|
+
\input{sections/introduction}
|
|
23
|
+
\input{sections/problem_setup}
|
|
24
|
+
\input{sections/method_system}
|
|
25
|
+
\input{sections/experimental_protocol}
|
|
26
|
+
\input{sections/main_results}
|
|
27
|
+
|
|
28
|
+
% Optional modules: enable only if the current paper shape needs them.
|
|
29
|
+
% \input{sections/related_work}
|
|
30
|
+
% \input{sections/ablations}
|
|
31
|
+
% \input{sections/discussion_scope}
|
|
32
|
+
|
|
33
|
+
\input{sections/conclusion}
|
|
34
|
+
|
|
35
|
+
% Uncomment after citations and BibTeX entries are ready.
|
|
36
|
+
% \bibliographystyle{plain}
|
|
37
|
+
% \bibliography{references}
|
|
38
|
+
|
|
39
|
+
\end{document}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
\section{Discussion / Scope Note}
|
|
2
|
+
|
|
3
|
+
% Use this optional module only when the paper benefits from a dedicated
|
|
4
|
+
% place to separate observation from interpretation or to state the evidence
|
|
5
|
+
% boundary explicitly. Do not enable it by default.
|
|
6
|
+
|
|
7
|
+
Separate observed results from interpretation, and make the current evidence boundary explicit only if this paper shape needs a dedicated scope note.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
\section{Main Results}
|
|
2
|
+
|
|
3
|
+
% Draft this section from paper/claim_inventory.md and paper/figures_manifest.md.
|
|
4
|
+
% For figure-backed claims, introduce the figure with its callout_sentence
|
|
5
|
+
% before or at the first discussion point, then keep the figure block fields
|
|
6
|
+
% aligned with file_path, caption_short, caption_long, latex_label, and
|
|
7
|
+
% placement_hint from the manifest.
|
|
8
|
+
|
|
9
|
+
State the supported result claim, the quantitative evidence, the named baseline, and the boundary note for each main-results paragraph.
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
# Paper Draft
|
|
2
|
+
|
|
3
|
+
This is a modular paper template, not a fixed universal outline.
|
|
4
|
+
|
|
5
|
+
Core sections should usually stay:
|
|
6
|
+
|
|
7
|
+
- Abstract
|
|
8
|
+
- Introduction
|
|
9
|
+
- Problem Setup
|
|
10
|
+
- Method / System
|
|
11
|
+
- Experimental Protocol
|
|
12
|
+
- Main Results
|
|
13
|
+
- Conclusion
|
|
14
|
+
|
|
15
|
+
Optional modules should be added only when they help the current paper:
|
|
16
|
+
|
|
17
|
+
- Related Work
|
|
18
|
+
- Ablations and Additional Analysis
|
|
19
|
+
- Discussion / Scope Note
|
|
20
|
+
- Boundary / Scope surface
|
|
21
|
+
|
|
22
|
+
Choose the paper shape before filling the outline:
|
|
23
|
+
|
|
24
|
+
- `result_note`
|
|
25
|
+
- use the core sections only
|
|
26
|
+
- `systems_full`
|
|
27
|
+
- enable optional modules only when they carry real argumentative load
|
|
28
|
+
- `artifact_summary`
|
|
29
|
+
- keep the shape lean and boundary-aware
|
|
30
|
+
- `workshop_short`
|
|
31
|
+
- compress setup and method, and avoid optional modules unless required
|
|
32
|
+
|
|
33
|
+
## Abstract
|
|
34
|
+
|
|
35
|
+
Use exactly four functional sentence types in this order:
|
|
36
|
+
|
|
37
|
+
1. problem statement
|
|
38
|
+
2. method or system statement
|
|
39
|
+
3. strongest quantitative result
|
|
40
|
+
4. scope boundary or evidence boundary
|
|
41
|
+
|
|
42
|
+
Do not use unsupported adjectives such as "strong", "significant", or "robust" without a metric.
|
|
43
|
+
Keep the abstract to four sentences in the default profile.
|
|
44
|
+
|
|
45
|
+
## 1. Introduction
|
|
46
|
+
|
|
47
|
+
Paragraph 1:
|
|
48
|
+
- define the problem and why it matters
|
|
49
|
+
|
|
50
|
+
Paragraph 2:
|
|
51
|
+
- explain the gap in prior methods or current workflow
|
|
52
|
+
|
|
53
|
+
Paragraph 3:
|
|
54
|
+
- summarize contributions without introducing unsupported result claims
|
|
55
|
+
|
|
56
|
+
Every claimed contribution here must map to a later section.
|
|
57
|
+
Keep the default introduction to three compact paragraphs.
|
|
58
|
+
|
|
59
|
+
## Optional: Related Work
|
|
60
|
+
|
|
61
|
+
If a related-work section is needed, keep it focused on:
|
|
62
|
+
|
|
63
|
+
- closest comparison family
|
|
64
|
+
- direct difference in target, assumptions, or evidence type
|
|
65
|
+
- what is compared directly versus what is only contextualized
|
|
66
|
+
|
|
67
|
+
Do not turn related work into a generic survey dump.
|
|
68
|
+
|
|
69
|
+
## 2. Problem Setup
|
|
70
|
+
|
|
71
|
+
Define task scope, assumptions, notation, evaluation target, and any constraints needed to interpret the paper.
|
|
72
|
+
Keep this section definition-heavy and result-light.
|
|
73
|
+
|
|
74
|
+
## 3. Method / System
|
|
75
|
+
|
|
76
|
+
Describe the system or method design.
|
|
77
|
+
|
|
78
|
+
Separate:
|
|
79
|
+
- what is implemented
|
|
80
|
+
- what is claimed as a contribution
|
|
81
|
+
- what is only an engineering choice
|
|
82
|
+
|
|
83
|
+
Prefer short subsections or short paragraphs over one long implementation block.
|
|
84
|
+
|
|
85
|
+
## 4. Experimental Protocol
|
|
86
|
+
|
|
87
|
+
State:
|
|
88
|
+
|
|
89
|
+
- baseline family
|
|
90
|
+
- evaluation setup
|
|
91
|
+
- quality guard or protocol constraint
|
|
92
|
+
- evidence boundary (`simulator`, `local_runtime`, or `runtime`)
|
|
93
|
+
|
|
94
|
+
State the evaluation regime before making any performance claim.
|
|
95
|
+
|
|
96
|
+
## 5. Main Results
|
|
97
|
+
|
|
98
|
+
Every paragraph in this section must:
|
|
99
|
+
|
|
100
|
+
- map back to at least one `claim_id`
|
|
101
|
+
- contain at least one quantitative statement
|
|
102
|
+
- name a baseline or comparison target
|
|
103
|
+
- state a takeaway, not just restate a figure
|
|
104
|
+
|
|
105
|
+
Recommended paragraph structure:
|
|
106
|
+
|
|
107
|
+
1. claim sentence
|
|
108
|
+
2. evidence sentence
|
|
109
|
+
3. comparison sentence
|
|
110
|
+
4. boundary or caveat sentence
|
|
111
|
+
|
|
112
|
+
Figure/text rules:
|
|
113
|
+
|
|
114
|
+
- Introduce each figure with a callout sentence before or at first discussion.
|
|
115
|
+
- A figure callout must contain a takeaway, not just "Figure X shows ..."
|
|
116
|
+
- If a figure supports a headline claim, the text should also name the relevant `claim_id` or clearly map to it.
|
|
117
|
+
- Prefer shorter result paragraphs with one main claim each.
|
|
118
|
+
|
|
119
|
+
## 6. Ablations and Additional Analysis
|
|
120
|
+
|
|
121
|
+
Keep secondary analysis separate from headline results.
|
|
122
|
+
|
|
123
|
+
Do not let ablations silently carry the main claim.
|
|
124
|
+
Use this section to explain or stress-test the main result, not to replace it.
|
|
125
|
+
|
|
126
|
+
## Optional: Discussion / Scope Note
|
|
127
|
+
|
|
128
|
+
Use this module when the paper needs an explicit place to:
|
|
129
|
+
|
|
130
|
+
- separate observation from interpretation
|
|
131
|
+
- state evidence boundary
|
|
132
|
+
- mark what is intentionally not claimed
|
|
133
|
+
- explain where the current artifact does not generalize
|
|
134
|
+
|
|
135
|
+
This can be a short section, a subsection, or a structured paragraph block.
|
|
136
|
+
|
|
137
|
+
## Optional: Boundary / Scope Surface
|
|
138
|
+
|
|
139
|
+
Do not force a dedicated limitations section by default.
|
|
140
|
+
|
|
141
|
+
Pick the lightest surface that fits the current paper:
|
|
142
|
+
|
|
143
|
+
- one short caveat paragraph in `Main Results`
|
|
144
|
+
- one short scope paragraph in `Conclusion`
|
|
145
|
+
- an optional `Discussion / Scope Note`
|
|
146
|
+
- a standalone `paper/boundary_notes.md` during drafting
|
|
147
|
+
|
|
148
|
+
Use a dedicated limitations section only if the venue or review process explicitly expects one.
|
|
149
|
+
|
|
150
|
+
## 7. Conclusion
|
|
151
|
+
|
|
152
|
+
Restate only the strongest supported claims.
|
|
153
|
+
|
|
154
|
+
Do not introduce a new claim, baseline, or interpretation here.
|
|
155
|
+
Keep the conclusion to 1-2 tight paragraphs in the default profile.
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
# Paragraph Contract
|
|
2
|
+
|
|
3
|
+
Use these rules when drafting sections for `paper/draft.md` or `paper/sections/*.tex`.
|
|
4
|
+
|
|
5
|
+
## Global Rules
|
|
6
|
+
|
|
7
|
+
- Prefer short paragraphs with one clear function over long mixed-purpose paragraphs.
|
|
8
|
+
- Every paragraph should have a dominant job: setup, claim, evidence, comparison, interpretation, or boundary note.
|
|
9
|
+
- If a paragraph mixes observation and interpretation, split it.
|
|
10
|
+
- If a paragraph makes a comparison, it must name the baseline or comparison target explicitly.
|
|
11
|
+
- If a paragraph cannot be tied to a source artifact, do not present it as a result paragraph.
|
|
12
|
+
|
|
13
|
+
## Abstract
|
|
14
|
+
|
|
15
|
+
- Sentence 1: define the problem.
|
|
16
|
+
- Sentence 2: state the method, system, or intervention.
|
|
17
|
+
- Sentence 3: state the strongest supported quantitative result.
|
|
18
|
+
- Sentence 4: state the scope boundary or evidence boundary.
|
|
19
|
+
|
|
20
|
+
Rules:
|
|
21
|
+
|
|
22
|
+
- Use only `confidence=high` claims here.
|
|
23
|
+
- Do not use praise words unless a number and baseline follow in the same sentence.
|
|
24
|
+
- Keep the abstract to exactly four sentences in the default template.
|
|
25
|
+
|
|
26
|
+
## Introduction
|
|
27
|
+
|
|
28
|
+
- Paragraph 1: problem and motivation
|
|
29
|
+
- Paragraph 2: gap or limitation in current approaches
|
|
30
|
+
- Paragraph 3: contribution summary
|
|
31
|
+
|
|
32
|
+
Rules:
|
|
33
|
+
|
|
34
|
+
- Do not preview unsupported result claims.
|
|
35
|
+
- Contributions must map to later sections.
|
|
36
|
+
- Keep the default introduction to three short paragraphs unless the venue profile says otherwise.
|
|
37
|
+
|
|
38
|
+
## Problem Setup
|
|
39
|
+
|
|
40
|
+
- Paragraph 1: define the task, setting, or operational problem.
|
|
41
|
+
- Paragraph 2: define evaluation target, constraints, and success criteria.
|
|
42
|
+
|
|
43
|
+
Rules:
|
|
44
|
+
|
|
45
|
+
- Prefer definitions and scope boundaries over motivation language.
|
|
46
|
+
- Do not smuggle results into the setup section.
|
|
47
|
+
|
|
48
|
+
## Method / System
|
|
49
|
+
|
|
50
|
+
- Paragraph 1: core design idea
|
|
51
|
+
- Paragraph 2: implementation structure
|
|
52
|
+
- Paragraph 3: what is claimed as the contribution versus what is only an engineering choice
|
|
53
|
+
|
|
54
|
+
Rules:
|
|
55
|
+
|
|
56
|
+
- Separate contribution-bearing design from ordinary implementation detail.
|
|
57
|
+
- If a design choice is not defended later, avoid overselling it here.
|
|
58
|
+
|
|
59
|
+
## Experimental Protocol
|
|
60
|
+
|
|
61
|
+
- Paragraph 1: baselines and comparison family
|
|
62
|
+
- Paragraph 2: workloads, data, or evaluation setting
|
|
63
|
+
- Paragraph 3: quality guardrails and evidence boundary
|
|
64
|
+
|
|
65
|
+
Rules:
|
|
66
|
+
|
|
67
|
+
- Always state the evaluation regime before summarizing the result.
|
|
68
|
+
- Make simulator, local-runtime, and runtime scopes explicit.
|
|
69
|
+
|
|
70
|
+
## Main Results
|
|
71
|
+
|
|
72
|
+
Each paragraph must contain:
|
|
73
|
+
|
|
74
|
+
1. a claim sentence
|
|
75
|
+
2. an evidence sentence
|
|
76
|
+
3. a baseline comparison sentence
|
|
77
|
+
4. a boundary or caveat sentence
|
|
78
|
+
|
|
79
|
+
Rules:
|
|
80
|
+
|
|
81
|
+
- Every paragraph must map to at least one `claim_id`.
|
|
82
|
+
- Every paragraph must include at least one quantitative statement.
|
|
83
|
+
- If the paragraph compares methods, it must name the baseline explicitly.
|
|
84
|
+
- Each figure should be introduced by a callout sentence before or at first discussion.
|
|
85
|
+
- A result paragraph should usually be 4-6 sentences, not a long narrative block.
|
|
86
|
+
|
|
87
|
+
## Ablations and Additional Analysis
|
|
88
|
+
|
|
89
|
+
- Paragraph 1: what secondary question is being tested
|
|
90
|
+
- Paragraph 2+: measured answer with comparison and takeaway
|
|
91
|
+
|
|
92
|
+
Rules:
|
|
93
|
+
|
|
94
|
+
- Keep ablations secondary. Do not let them silently carry the paper's main claim.
|
|
95
|
+
- If an ablation becomes central to the story, move the corresponding claim into `Main Results`.
|
|
96
|
+
|
|
97
|
+
## Discussion
|
|
98
|
+
|
|
99
|
+
- Start from an observed result.
|
|
100
|
+
- Then add interpretation.
|
|
101
|
+
|
|
102
|
+
Rules:
|
|
103
|
+
|
|
104
|
+
- Keep observation and interpretation separable.
|
|
105
|
+
- Do not hide speculation inside result phrasing.
|
|
106
|
+
|
|
107
|
+
## Related Work
|
|
108
|
+
|
|
109
|
+
- Paragraph 1: closest comparison family
|
|
110
|
+
- Paragraph 2: key difference in assumption, target, or evidence
|
|
111
|
+
- Paragraph 3: what is compared directly versus what is only contextualized
|
|
112
|
+
|
|
113
|
+
Rules:
|
|
114
|
+
|
|
115
|
+
- Do not turn related work into a survey dump.
|
|
116
|
+
- Compare on dimensions that matter for this paper: target, evidence type, baseline family, and scope.
|
|
117
|
+
|
|
118
|
+
## Boundary / Scope Surface
|
|
119
|
+
|
|
120
|
+
- State the evidence boundary.
|
|
121
|
+
- State what is missing.
|
|
122
|
+
- State what is intentionally not claimed.
|
|
123
|
+
|
|
124
|
+
Rules:
|
|
125
|
+
|
|
126
|
+
- Put this material in the lightest surface that fits the current paper: `Main Results`, `Discussion / Scope Note`, `Conclusion`, or `paper/boundary_notes.md`.
|
|
127
|
+
- Name the missing validation directly.
|
|
128
|
+
- If a claim depends on simulator evidence, say so explicitly.
|
|
129
|
+
|
|
130
|
+
## Conclusion
|
|
131
|
+
|
|
132
|
+
- Restate the strongest supported claims only.
|
|
133
|
+
|
|
134
|
+
Rules:
|
|
135
|
+
|
|
136
|
+
- No new claim.
|
|
137
|
+
- No new baseline comparison.
|
|
138
|
+
- No new interpretation that did not appear earlier.
|
|
139
|
+
- Prefer 1-2 tight paragraphs over a long recap.
|
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
# Paragraph Examples
|
|
2
|
+
|
|
3
|
+
Use these as movable writing patterns, not as a fixed chapter-by-chapter script.
|
|
4
|
+
|
|
5
|
+
The same pattern can appear in different places depending on the paper shape:
|
|
6
|
+
|
|
7
|
+
- a framing paragraph can appear in `Introduction`, `Problem Setup`, or the opening of a short report
|
|
8
|
+
- a quantified claim paragraph can appear in `Main Results`, an artifact summary, or a rebuttal appendix
|
|
9
|
+
- a boundary paragraph can appear in `Main Results`, `Discussion / Scope Note`, `Conclusion`, or `paper/boundary_notes.md`
|
|
10
|
+
|
|
11
|
+
## Pattern 1: Framing the Problem
|
|
12
|
+
|
|
13
|
+
### Bad
|
|
14
|
+
|
|
15
|
+
Inference optimization has become very important in many domains. Many prior methods have tried to solve this problem. Our method is better and more comprehensive than existing approaches.
|
|
16
|
+
|
|
17
|
+
Problems:
|
|
18
|
+
|
|
19
|
+
- generic setup
|
|
20
|
+
- no specific gap
|
|
21
|
+
- unsupported comparative claim
|
|
22
|
+
|
|
23
|
+
### Better
|
|
24
|
+
|
|
25
|
+
Fixed-budget inference systems often face a hard tradeoff between latency and quality. Existing baselines expose this tradeoff, but they do not make it easy to preserve quality under the same resource envelope. This work targets that gap and focuses on artifact-backed tradeoff improvement rather than unconstrained speedup claims.
|
|
26
|
+
|
|
27
|
+
Why this is better:
|
|
28
|
+
|
|
29
|
+
- defines the problem concretely
|
|
30
|
+
- names the gap
|
|
31
|
+
- avoids unsupported boasting
|
|
32
|
+
|
|
33
|
+
## Pattern 2: Quantified Claim
|
|
34
|
+
|
|
35
|
+
### Bad
|
|
36
|
+
|
|
37
|
+
KV2 shows strong and promising gains across the board. The method appears robust and significantly better than prior approaches. These results suggest the design is highly effective.
|
|
38
|
+
|
|
39
|
+
Problems:
|
|
40
|
+
|
|
41
|
+
- no number
|
|
42
|
+
- no baseline
|
|
43
|
+
- no evidence boundary
|
|
44
|
+
- interpretation blended into the result claim
|
|
45
|
+
|
|
46
|
+
### Better
|
|
47
|
+
|
|
48
|
+
KV2 improves mean TTFT by 17.53% versus INT4-FIFO under the stated simulator protocol. The comparison is measured under `quality_penalty_mean <= 0.02` and is anchored in `claim-001`. This result supports a lower-latency tradeoff within simulator evaluation, but it does not yet establish full runtime behavior.
|
|
49
|
+
|
|
50
|
+
Why this is better:
|
|
51
|
+
|
|
52
|
+
- includes a metric
|
|
53
|
+
- names the baseline
|
|
54
|
+
- points to a claim anchor
|
|
55
|
+
- states the evidence boundary
|
|
56
|
+
|
|
57
|
+
## Pattern 3: Figure-Led Result
|
|
58
|
+
|
|
59
|
+
### Bad
|
|
60
|
+
|
|
61
|
+
Figure 2 shows the main result.
|
|
62
|
+
|
|
63
|
+
Problems:
|
|
64
|
+
|
|
65
|
+
- no takeaway
|
|
66
|
+
- no metric
|
|
67
|
+
- no explanation of why the figure matters
|
|
68
|
+
|
|
69
|
+
### Better
|
|
70
|
+
|
|
71
|
+
Figure 2 summarizes the latency-quality tradeoff and shows that KV2 reduces mean TTFT relative to INT4-FIFO under the stated simulator guardrail. This figure supports `claim-001` and should be read as simulator evidence rather than runtime validation.
|
|
72
|
+
|
|
73
|
+
Why this is better:
|
|
74
|
+
|
|
75
|
+
- states the takeaway
|
|
76
|
+
- names the comparison target
|
|
77
|
+
- marks the evidence boundary
|
|
78
|
+
|
|
79
|
+
## Pattern 4: Comparison Paragraph
|
|
80
|
+
|
|
81
|
+
### Bad
|
|
82
|
+
|
|
83
|
+
Our method outperforms the baseline in most cases and is generally better than previous approaches.
|
|
84
|
+
|
|
85
|
+
Problems:
|
|
86
|
+
|
|
87
|
+
- does not say which baseline
|
|
88
|
+
- does not say what metric improved
|
|
89
|
+
- hides regime differences behind “most cases”
|
|
90
|
+
|
|
91
|
+
### Better
|
|
92
|
+
|
|
93
|
+
Relative to INT4-FIFO, KV2 improves mean TTFT while preserving the stated quality guard, but it does not exceed KVQuant-3bit-1% on bytes/request under the same harness. This makes the current result a balanced tradeoff claim rather than a blanket “best overall” claim.
|
|
94
|
+
|
|
95
|
+
Why this is better:
|
|
96
|
+
|
|
97
|
+
- names both comparison targets
|
|
98
|
+
- distinguishes the winning dimension from the losing one
|
|
99
|
+
- prevents overclaim
|
|
100
|
+
|
|
101
|
+
## Pattern 5: Interpretation Paragraph
|
|
102
|
+
|
|
103
|
+
### Bad
|
|
104
|
+
|
|
105
|
+
These results prove that KV2 is generally superior and will likely work well across all realistic deployments.
|
|
106
|
+
|
|
107
|
+
Problems:
|
|
108
|
+
|
|
109
|
+
- turns a bounded observation into a general claim
|
|
110
|
+
- mixes evidence and speculation
|
|
111
|
+
- overgeneralizes scope
|
|
112
|
+
|
|
113
|
+
### Better
|
|
114
|
+
|
|
115
|
+
The measured simulator results indicate a lower-latency tradeoff under the reported protocol. One plausible interpretation is that the KV2 design better preserves quality under a fixed budget, but that interpretation still requires runtime validation and broader workload coverage.
|
|
116
|
+
|
|
117
|
+
Why this is better:
|
|
118
|
+
|
|
119
|
+
- starts from the observed result
|
|
120
|
+
- labels interpretation as interpretation
|
|
121
|
+
- keeps the open validation gap visible
|
|
122
|
+
|
|
123
|
+
## Pattern 6: Boundary Paragraph
|
|
124
|
+
|
|
125
|
+
### Bad
|
|
126
|
+
|
|
127
|
+
There are some limitations and future work remains.
|
|
128
|
+
|
|
129
|
+
Problems:
|
|
130
|
+
|
|
131
|
+
- vague
|
|
132
|
+
- hides the real evidence boundary
|
|
133
|
+
- says nothing actionable
|
|
134
|
+
|
|
135
|
+
### Better
|
|
136
|
+
|
|
137
|
+
The current artifact does not establish full runtime behavior because the headline comparisons are still simulator-backed. Runtime smoke tests, broader workloads, and missing baseline replications remain open, so the paper intentionally avoids stronger deployment claims.
|
|
138
|
+
|
|
139
|
+
Why this is better:
|
|
140
|
+
|
|
141
|
+
- names the missing validation
|
|
142
|
+
- states what is not claimed
|
|
143
|
+
- ties the boundary to the actual artifact
|
|
144
|
+
|
|
145
|
+
## Pattern 7: Closing Sentence
|
|
146
|
+
|
|
147
|
+
### Bad
|
|
148
|
+
|
|
149
|
+
Overall, our method is a highly robust and comprehensive solution for efficient inference.
|
|
150
|
+
|
|
151
|
+
Problems:
|
|
152
|
+
|
|
153
|
+
- empty praise
|
|
154
|
+
- no measurable support
|
|
155
|
+
- overgeneralized scope
|
|
156
|
+
|
|
157
|
+
### Better
|
|
158
|
+
|
|
159
|
+
Overall, the current artifact supports lower-latency tradeoffs under the reported simulator protocol, while runtime validation and broader workload coverage remain open.
|
|
160
|
+
|
|
161
|
+
Why this is better:
|
|
162
|
+
|
|
163
|
+
- closes on the strongest supported claim
|
|
164
|
+
- keeps the scope visible
|
|
165
|
+
- avoids turning the conclusion into a slogan
|
|
166
|
+
|
|
167
|
+
## How To Use These Examples
|
|
168
|
+
|
|
169
|
+
- Pick the pattern that matches the paragraph's job, not the section name.
|
|
170
|
+
- If one paragraph is trying to do two jobs, split it.
|
|
171
|
+
- Prefer adapting a pattern to the current evidence base over copying its sentence order exactly.
|