superlab 0.1.0 → 0.1.2
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.md +23 -23
- package/README.zh-CN.md +22 -21
- package/lib/i18n.cjs +626 -23
- package/lib/install.cjs +31 -0
- package/package-assets/claude/commands/lab/spec.md +1 -1
- package/package-assets/claude/commands/lab/write.md +1 -1
- package/package-assets/codex/prompts/lab-spec.md +1 -1
- package/package-assets/codex/prompts/lab-write.md +1 -1
- package/package-assets/shared/changes/README.md +10 -0
- package/package-assets/shared/config/workflow.json +5 -0
- package/package-assets/shared/context/decisions.md +11 -0
- package/package-assets/shared/context/evidence-index.md +16 -0
- package/package-assets/shared/context/mission.md +27 -0
- package/package-assets/shared/context/open-questions.md +11 -0
- package/package-assets/shared/context/state.md +19 -0
- package/package-assets/shared/examples/minimal-uplift-workflow.md +4 -4
- package/package-assets/shared/skills/lab/SKILL.md +54 -9
- package/package-assets/shared/skills/lab/references/brainstorming-integration.md +21 -0
- package/package-assets/shared/skills/lab/references/paper-writing/abstract.md +102 -0
- package/package-assets/shared/skills/lab/references/paper-writing/conclusion.md +35 -0
- package/package-assets/shared/skills/lab/references/paper-writing/does-my-writing-flow-source.md +45 -0
- package/package-assets/shared/skills/lab/references/paper-writing/experiments.md +102 -0
- package/package-assets/shared/skills/lab/references/paper-writing/introduction.md +408 -0
- package/package-assets/shared/skills/lab/references/paper-writing/method.md +196 -0
- package/package-assets/shared/skills/lab/references/paper-writing/paper-review.md +86 -0
- package/package-assets/shared/skills/lab/references/paper-writing/related-work.md +41 -0
- package/package-assets/shared/skills/lab/references/paper-writing-integration.md +29 -28
- package/package-assets/shared/skills/lab/references/workflow.md +1 -1
- package/package-assets/shared/skills/lab/stages/idea.md +43 -7
- package/package-assets/shared/skills/lab/stages/iterate.md +32 -0
- package/package-assets/shared/skills/lab/stages/report.md +19 -0
- package/package-assets/shared/skills/lab/stages/review.md +30 -0
- package/package-assets/shared/skills/lab/stages/run.md +17 -0
- package/package-assets/shared/skills/lab/stages/spec.md +36 -4
- package/package-assets/shared/skills/lab/stages/write.md +47 -15
- package/package-assets/shared/templates/design.md +10 -0
- package/package-assets/shared/templates/idea.md +76 -8
- package/package-assets/shared/templates/iteration-report.md +4 -0
- package/package-assets/shared/templates/paper-plan.md +12 -0
- package/package-assets/shared/templates/paper-section.md +24 -6
- package/package-assets/shared/templates/paper-section.tex +10 -0
- package/package-assets/shared/templates/paper.tex +29 -0
- package/package-assets/shared/templates/proposal.md +10 -0
- package/package-assets/shared/templates/review-checklist.md +23 -0
- package/package-assets/shared/templates/spec.md +7 -2
- package/package-assets/shared/templates/tasks.md +3 -1
- package/package-assets/shared/templates/write-iteration.md +5 -0
- package/package.json +3 -3
- package/package-assets/shared/scripts/check_openspec.sh +0 -10
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# Experiments Writing Guide
|
|
2
|
+
|
|
3
|
+
## Goal
|
|
4
|
+
|
|
5
|
+
Convince reviewers with complete evidence on effectiveness, causality, and practical value.
|
|
6
|
+
|
|
7
|
+
## Three Core Questions
|
|
8
|
+
|
|
9
|
+
1. Is the method better than strong baselines?
|
|
10
|
+
- Run comparison experiments against strong and recent baselines.
|
|
11
|
+
- Report standard metrics on the main benchmark(s).
|
|
12
|
+
- Include SOTA or strongest public methods, not only weak baselines.
|
|
13
|
+
- Keep protocol fair (same data split, preprocessing, and evaluation settings).
|
|
14
|
+
2. Which modules/design choices make the gain?
|
|
15
|
+
- Run ablation studies for each key module/design choice.
|
|
16
|
+
- Use remove/replace/disable variants and report delta to full model.
|
|
17
|
+
- Include component interaction ablations when modules are coupled.
|
|
18
|
+
3. How far can the method generalize under harder settings?
|
|
19
|
+
- Run demos/evaluations on harder or out-of-distribution settings.
|
|
20
|
+
- Add stress-test scenarios (more complex scenes, rarer cases, noisier inputs, or stricter constraints).
|
|
21
|
+
- Report both gains and failure modes to show realistic boundaries.
|
|
22
|
+
|
|
23
|
+
## Experiment Planning
|
|
24
|
+
|
|
25
|
+
```mermaid
|
|
26
|
+
flowchart TB
|
|
27
|
+
A["Key Paper Claims"] --> B["What Contributions Are Claimed?"]
|
|
28
|
+
B --> C1["Contribution 1"]
|
|
29
|
+
B --> C2["Contribution 2"]
|
|
30
|
+
B --> C3["Contribution 3"]
|
|
31
|
+
C1 --> D1["Validation Experiment 1"]
|
|
32
|
+
C2 --> D2["Validation Experiment 2"]
|
|
33
|
+
C3 --> D3["Validation Experiment 3"]
|
|
34
|
+
|
|
35
|
+
E["Method Pipeline Figure"] --> F["What Modules and Parameters Matter?"]
|
|
36
|
+
F --> G1["Technical Module 1"]
|
|
37
|
+
F --> G2["Technical Module 2"]
|
|
38
|
+
F --> G3["Key Parameter 1"]
|
|
39
|
+
F --> G4["Key Parameter 2"]
|
|
40
|
+
G1 --> H1["Ablation Study 1"]
|
|
41
|
+
G2 --> H2["Ablation Study 2"]
|
|
42
|
+
G3 --> H3["Ablation Study 3"]
|
|
43
|
+
G4 --> H4["Ablation Study 4"]
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Experiment Section Decomposition
|
|
47
|
+
|
|
48
|
+
```mermaid
|
|
49
|
+
flowchart TB
|
|
50
|
+
S1["Experimental Setup"] --> S2["Validation Experiment 1"]
|
|
51
|
+
S2 --> S3["Validation Experiment 2"]
|
|
52
|
+
S3 --> S4["Ablation Studies"]
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Figure/Table Writing Rules
|
|
56
|
+
|
|
57
|
+
`Good tables are part of experiment communication quality, not decoration.`
|
|
58
|
+
|
|
59
|
+
1. Figure captions and table captions are equally important in the writing quality of Experiments.
|
|
60
|
+
|
|
61
|
+
### Hard rules
|
|
62
|
+
|
|
63
|
+
1. Put caption above the table.
|
|
64
|
+
2. Avoid vertical lines (`|`) in tabular columns.
|
|
65
|
+
3. Do not use double rules or dense `\hline` stacks.
|
|
66
|
+
4. Use `booktabs` style (`\toprule`, `\midrule`, `\bottomrule`) for clean structure.
|
|
67
|
+
5. Use as few horizontal rules as possible; lines should separate groups, not every row.
|
|
68
|
+
6. Highlight key numbers (best/second-best or target rows) with subtle color emphasis.
|
|
69
|
+
|
|
70
|
+
### Readability rules from review practice
|
|
71
|
+
|
|
72
|
+
1. Label metric direction in column headers (for example `PSNR ↑`, `LPIPS ↓`).
|
|
73
|
+
2. Add units when needed so values are interpretable without guessing.
|
|
74
|
+
3. Align text columns left; keep numeric columns consistently aligned.
|
|
75
|
+
4. Keep numeric precision consistent (same decimal places within a metric column).
|
|
76
|
+
5. Group multi-dataset or multi-setting results using `\multicolumn` + `\cmidrule`, not vertical separators.
|
|
77
|
+
6. One table, one message: do not mix unrelated results in a single table.
|
|
78
|
+
7. If rows represent different attributes/ablations, encode that explicitly in row names or attribute columns.
|
|
79
|
+
8. Keep caption focused on setting/protocol/notation, not long discussion.
|
|
80
|
+
9. If there is little detail to explain, use one concise sentence to summarize the main result.
|
|
81
|
+
10. For single-column figures/tables in two-column papers, prefer placing them in the right column when layout allows, so readers can enter the page from the left-top text without breaking reading flow.
|
|
82
|
+
|
|
83
|
+
### Minimal LaTeX checklist
|
|
84
|
+
|
|
85
|
+
1. Add packages in preamble: `\usepackage{booktabs}`, `\usepackage{colortbl,xcolor}` (and optionally `\usepackage{siunitx}` for decimal alignment).
|
|
86
|
+
2. Replace `\hline`-heavy style with `\toprule/\midrule/\bottomrule`.
|
|
87
|
+
3. Put `\caption{...}` before `\label{...}` and keep caption above.
|
|
88
|
+
4. Use restrained highlighting; never color too many cells.
|
|
89
|
+
|
|
90
|
+
## Recommended Ablation Package
|
|
91
|
+
|
|
92
|
+
1. One core ablation table for all major contributions.
|
|
93
|
+
2. Several focused mini-ablations for module-level design choices.
|
|
94
|
+
3. Matching qualitative visual results for each important ablation.
|
|
95
|
+
|
|
96
|
+
## Experimental Rigor Checklist
|
|
97
|
+
|
|
98
|
+
1. Are baselines recent and relevant?
|
|
99
|
+
2. Are metrics sufficient and standard for this task?
|
|
100
|
+
3. Is ablation tied to every key design claim?
|
|
101
|
+
4. Are claims in Abstract/Introduction supported by reported numbers?
|
|
102
|
+
5. Are limitations of evaluation scope explicitly stated?
|
|
@@ -0,0 +1,408 @@
|
|
|
1
|
+
# Introduction Writing Guide
|
|
2
|
+
|
|
3
|
+
## Goal
|
|
4
|
+
|
|
5
|
+
Write a strong introduction in three steps:
|
|
6
|
+
|
|
7
|
+
1. Think through the introduction logic.
|
|
8
|
+
2. Apply a suitable template below.
|
|
9
|
+
3. Revise the introduction repeatedly.
|
|
10
|
+
|
|
11
|
+
## Introduction Logic Map
|
|
12
|
+
|
|
13
|
+
```mermaid
|
|
14
|
+
graph LR
|
|
15
|
+
L1[What task are we solving]
|
|
16
|
+
L2[Which metrics should this task improve]
|
|
17
|
+
L3[SOTA methods fail to meet target metrics]
|
|
18
|
+
L4[Root technical issue behind this failure]
|
|
19
|
+
L5[Our technical solution and method pipeline]
|
|
20
|
+
L6[Why the solution works]
|
|
21
|
+
L7[Additional technical contributions]
|
|
22
|
+
|
|
23
|
+
R1[Part 1 Task applications and target metrics]
|
|
24
|
+
R2[Part 2 SOTA methods failure and root issue]
|
|
25
|
+
R3[Part 3 Proposed solution and why it works]
|
|
26
|
+
R4[Part 4 Additional contributions and impact]
|
|
27
|
+
R5[Part 5 Experiments]
|
|
28
|
+
|
|
29
|
+
L1 --> L2
|
|
30
|
+
L2 --> L3
|
|
31
|
+
L3 --> L4
|
|
32
|
+
L4 --> L5
|
|
33
|
+
L5 --> L6
|
|
34
|
+
L6 --> L7
|
|
35
|
+
|
|
36
|
+
R1 --> R2
|
|
37
|
+
R2 --> R3
|
|
38
|
+
R3 --> R4
|
|
39
|
+
R4 --> R5
|
|
40
|
+
|
|
41
|
+
L1 --> R1
|
|
42
|
+
L2 --> R1
|
|
43
|
+
L3 --> R2
|
|
44
|
+
L4 --> R2
|
|
45
|
+
L5 --> R3
|
|
46
|
+
L6 --> R3
|
|
47
|
+
L7 --> R4
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## How to Think About Introduction: Backward First, Then Forward
|
|
51
|
+
|
|
52
|
+
### Backward reasoning (answer these first)
|
|
53
|
+
|
|
54
|
+
1. What technical problem do we solve, and why is there no well-established solution? (important)
|
|
55
|
+
2. What are the contributions of our pipeline (e.g., a new valuable task, a new valuable metric, a new technical problem, or a new technique)?
|
|
56
|
+
3. What are the benefits of our contributions, why can they solve this technical challenge, and what new insight do they bring? (important)
|
|
57
|
+
4. How do we use prior methods to lead readers to our solved challenge and our new insight?
|
|
58
|
+
|
|
59
|
+
### Forward story (write in this order)
|
|
60
|
+
|
|
61
|
+
1. Introduce the paper's task.
|
|
62
|
+
2. Use prior methods to lead to the technical challenge we solve.
|
|
63
|
+
3. Present xx contributions to solve this technical challenge.
|
|
64
|
+
4. Explain technical advantages of our contributions and explicitly express our new insight. (important)
|
|
65
|
+
|
|
66
|
+
## Section Skeleton
|
|
67
|
+
|
|
68
|
+
```latex
|
|
69
|
+
\section{Introduction}
|
|
70
|
+
% Task and application
|
|
71
|
+
% Technical challenge for previous methods (discuss around the technical challenge that we solved. A technical challenge includes both limitation and technical reason)
|
|
72
|
+
% Introduce our pipeline for solving the challenge
|
|
73
|
+
% Experiment
|
|
74
|
+
% Contributions
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Part A: Introduce Task and Application
|
|
78
|
+
|
|
79
|
+
### Version 1
|
|
80
|
+
|
|
81
|
+
`Version 1: If the task is relatively niche, introduce the task first, then introduce applications.`
|
|
82
|
+
|
|
83
|
+
Writing structure:
|
|
84
|
+
|
|
85
|
+
1. Define the task in one clear sentence (`what output` from `what input`).
|
|
86
|
+
2. Briefly explain the task objective or scope (optional).
|
|
87
|
+
3. Introduce application value with 2-3 representative scenarios.
|
|
88
|
+
|
|
89
|
+
Sentence skeleton:
|
|
90
|
+
|
|
91
|
+
1. `[xxx task] targets at recovering/reconstructing/estimating [xxx output] from [xxx input].`
|
|
92
|
+
2. `[xxx task] has a variety of applications such as [xxx], [xxx], and [xxx].`
|
|
93
|
+
|
|
94
|
+
Local cite:
|
|
95
|
+
|
|
96
|
+
1. `references/examples/introduction/version-1-task-then-application.md`
|
|
97
|
+
|
|
98
|
+
### Version 2
|
|
99
|
+
|
|
100
|
+
`Version 2: If the task is already familiar to most readers, introduce applications directly.`
|
|
101
|
+
|
|
102
|
+
Writing structure:
|
|
103
|
+
|
|
104
|
+
1. Skip formal task definition.
|
|
105
|
+
2. Open with application importance in one concise sentence.
|
|
106
|
+
3. Optionally append target requirement (e.g., accuracy/efficiency/robustness).
|
|
107
|
+
|
|
108
|
+
Sentence skeleton:
|
|
109
|
+
|
|
110
|
+
1. `[xxx task] has a variety of applications such as [xxx], [xxx], and [xxx].`
|
|
111
|
+
|
|
112
|
+
Local cite:
|
|
113
|
+
|
|
114
|
+
1. `references/examples/introduction/version-2-application-first.md`
|
|
115
|
+
|
|
116
|
+
### Version 3
|
|
117
|
+
|
|
118
|
+
`Version 3: Introduce applications of the general task first, then introduce the specific task setting. (Personally recommended when the setting is relatively new.)`
|
|
119
|
+
|
|
120
|
+
Writing structure:
|
|
121
|
+
|
|
122
|
+
1. Start from the general task and why it matters.
|
|
123
|
+
2. Narrow down to the specific setting of this paper.
|
|
124
|
+
3. Clarify exact input/output and boundary of the setting.
|
|
125
|
+
|
|
126
|
+
Sentence skeleton:
|
|
127
|
+
|
|
128
|
+
1. `[general task] has a variety of applications such as [xxx], [xxx], and [xxx].`
|
|
129
|
+
2. `This paper focuses on the specific setting of recovering/reconstructing/estimating [xxx output] from [xxx input].`
|
|
130
|
+
|
|
131
|
+
Local cite:
|
|
132
|
+
|
|
133
|
+
1. `references/examples/introduction/version-3-general-to-specific-setting.md`
|
|
134
|
+
|
|
135
|
+
### Version 4
|
|
136
|
+
|
|
137
|
+
`Version 4: If the task is familiar, introduce applications directly and expose the target technical challenge in the opening paragraph via previous methods (failure cases / target metric improvements).`
|
|
138
|
+
|
|
139
|
+
Writing structure:
|
|
140
|
+
|
|
141
|
+
1. Start with task/application importance.
|
|
142
|
+
2. Immediately summarize how representative previous methods work.
|
|
143
|
+
3. Immediately expose the unresolved failure case + technical reason.
|
|
144
|
+
4. Use this opening as a bridge to the later prior-work paragraphs.
|
|
145
|
+
|
|
146
|
+
Opening-paragraph skeleton:
|
|
147
|
+
|
|
148
|
+
1. `[Task/application importance sentence].`
|
|
149
|
+
2. `Given input ..., previous methods usually ...`
|
|
150
|
+
3. `Although they work in many cases, they fail at ... because ...`
|
|
151
|
+
|
|
152
|
+
Expert note:
|
|
153
|
+
|
|
154
|
+
1. It is often good if the first paragraph already states what problem you want to solve, instead of requiring several paragraphs of prior work before the challenge appears.
|
|
155
|
+
2. This style needs the right conditions and is less common.
|
|
156
|
+
3. Typical Version 4 flow: Part 1 (task + application and directly expose challenge via previous methods 1) -> Part 2 (previous methods 2 try to solve it but still fail) -> Part 3 (our method).
|
|
157
|
+
4. More common general flow: Part 1 (task + application) -> Part 2 (previous methods 1 + limitation) -> Part 3 (previous methods 2 + limitation; here the target challenge emerges) -> Part 4 (our method).
|
|
158
|
+
|
|
159
|
+
Local cite:
|
|
160
|
+
|
|
161
|
+
1. `references/examples/introduction/version-4-open-with-challenge.md`
|
|
162
|
+
|
|
163
|
+
## Part B: Introduce Technical Challenge for Previous Methods (Very Important)
|
|
164
|
+
|
|
165
|
+
Purpose:
|
|
166
|
+
|
|
167
|
+
1. Discuss around the exact technical challenge we solved.
|
|
168
|
+
2. Build reader curiosity about how to solve this challenge.
|
|
169
|
+
3. Make motivation/benefit of our method clear.
|
|
170
|
+
|
|
171
|
+
Key logic before writing (faithful translation):
|
|
172
|
+
|
|
173
|
+
1. First make clear the logic for "leading to the technical challenge we solved".
|
|
174
|
+
2. For existing tasks: identify which recent methods have this challenge, why those methods exist, and optionally what earlier challenge they were trying to solve.
|
|
175
|
+
3. For novel tasks: at minimum, define the technical challenge solved by our pipeline.
|
|
176
|
+
|
|
177
|
+
Important warning :
|
|
178
|
+
|
|
179
|
+
1. Do not first present a naive solution and then describe our improvement over it.
|
|
180
|
+
2. That writing makes the work look like a low-score incremental patch.
|
|
181
|
+
3. Even if the work is actually incremental, do not write it this way.
|
|
182
|
+
4. Why: this writing style can erase reader curiosity and make the idea look straightforward only because the writing hand-holds the reader.
|
|
183
|
+
|
|
184
|
+
### Technical-Challenge Version 1 (existing task, with existing methods)
|
|
185
|
+
|
|
186
|
+
`Version 1: For existing tasks, discuss the challenge chain from general challenge -> traditional methods -> recent methods -> remaining challenge that we solve.`
|
|
187
|
+
|
|
188
|
+
Writing structure:
|
|
189
|
+
|
|
190
|
+
1. Start with a general challenge statement for this task.
|
|
191
|
+
2. Briefly summarize traditional methods and their limitation.
|
|
192
|
+
3. Briefly summarize recent methods (1) and their limitation with technical reason.
|
|
193
|
+
4. Briefly summarize recent methods (2) and their limitation with technical reason.
|
|
194
|
+
5. Ensure the final limitation is exactly the challenge your method solves.
|
|
195
|
+
|
|
196
|
+
Sentence skeleton:
|
|
197
|
+
|
|
198
|
+
1. `This problem is particularly challenging due to ...`
|
|
199
|
+
2. `To overcome these challenges, traditional methods ... However, they ...`
|
|
200
|
+
3. `Recently, ... methods ... However, they ... because ...`
|
|
201
|
+
4. `To overcome this challenge, ... methods ... However, they ... because ...`
|
|
202
|
+
|
|
203
|
+
Local cite:
|
|
204
|
+
|
|
205
|
+
1. `references/examples/introduction/technical-challenge-version-1-existing-task.md`
|
|
206
|
+
|
|
207
|
+
### Technical-Challenge Version 2 (existing task + our insight seen in traditional methods)
|
|
208
|
+
|
|
209
|
+
`Version 2: For existing tasks, when our insight has historical roots in traditional methods, use that line as conceptual backing and then show why new methods still fail.`
|
|
210
|
+
|
|
211
|
+
Writing structure:
|
|
212
|
+
|
|
213
|
+
1. Start from mainstream methods and state their limitation.
|
|
214
|
+
2. Introduce a classical/traditional line that already contains insight similar to yours.
|
|
215
|
+
3. Explain why that classical line is still insufficient.
|
|
216
|
+
4. Return to modern methods and show the unresolved technical reason.
|
|
217
|
+
5. Bridge to your method naturally.
|
|
218
|
+
|
|
219
|
+
Sentence skeleton:
|
|
220
|
+
|
|
221
|
+
1. `Traditional/recent methods ... However, they ... because ...`
|
|
222
|
+
2. `To overcome this problem, a typical approach is [insight], which has long been explored ...`
|
|
223
|
+
3. `However, these methods still ... because ...`
|
|
224
|
+
4. `To overcome this challenge, newer methods ... However, they ... because ...`
|
|
225
|
+
|
|
226
|
+
Local cite:
|
|
227
|
+
|
|
228
|
+
1. `references/examples/introduction/technical-challenge-version-2-existing-task-insight-backed-by-traditional.md`
|
|
229
|
+
|
|
230
|
+
### Technical-Challenge Version 3 (novel task, no direct methods)
|
|
231
|
+
|
|
232
|
+
`Version 3: For novel tasks without direct prior methods, define the challenge directly and decompose it into several concrete challenge points.`
|
|
233
|
+
|
|
234
|
+
Writing structure:
|
|
235
|
+
|
|
236
|
+
1. State the goal and explain that the problem is challenging for N reasons.
|
|
237
|
+
2. Use `First/Second/Finally` to separate independent challenge points.
|
|
238
|
+
3. For each point, state the observable limitation and the technical reason.
|
|
239
|
+
4. End with a transition to your pipeline.
|
|
240
|
+
|
|
241
|
+
Sentence skeleton:
|
|
242
|
+
|
|
243
|
+
1. `In this work, our goal is to ... This problem is challenging for three reasons.`
|
|
244
|
+
2. `First, ...`
|
|
245
|
+
3. `Second, ...`
|
|
246
|
+
4. `Finally, ...`
|
|
247
|
+
|
|
248
|
+
Local cite:
|
|
249
|
+
|
|
250
|
+
1. `references/examples/introduction/technical-challenge-version-3-novel-task.md`
|
|
251
|
+
|
|
252
|
+
## Part C: Introduce Our Pipeline for Solving the Challenge
|
|
253
|
+
|
|
254
|
+
Key questions before writing:
|
|
255
|
+
|
|
256
|
+
### For existing tasks
|
|
257
|
+
|
|
258
|
+
1. What technical challenge does our pipeline solve?
|
|
259
|
+
2. What is our technical contribution?
|
|
260
|
+
3. Why can our method work in essence?
|
|
261
|
+
4. What benefits does our method have over previous methods?
|
|
262
|
+
|
|
263
|
+
### For novel tasks
|
|
264
|
+
|
|
265
|
+
1. What technical challenge does our pipeline solve?
|
|
266
|
+
2. What is our technical contribution?
|
|
267
|
+
3. Why can our method work in essence?
|
|
268
|
+
|
|
269
|
+
### Pipeline Version 1
|
|
270
|
+
|
|
271
|
+
`Version 1: One contribution with multiple advantages, and one teaser figure to present the basic idea.`
|
|
272
|
+
|
|
273
|
+
Writing structure:
|
|
274
|
+
|
|
275
|
+
1. Introduce one core framework/representation for the target task.
|
|
276
|
+
2. Point to teaser figure for the basic idea.
|
|
277
|
+
3. State key novelty in one sentence.
|
|
278
|
+
4. Explain concrete implementation steps (`Specifically, ...`).
|
|
279
|
+
5. State multiple advantages (`In contrast ...`, `Another advantage ...`).
|
|
280
|
+
|
|
281
|
+
Sentence skeleton:
|
|
282
|
+
|
|
283
|
+
1. `In this paper, we propose a novel framework/representation, named ..., for ...`
|
|
284
|
+
2. `The basic idea is illustrated in Figure ...`
|
|
285
|
+
3. `Our innovation is in ...`
|
|
286
|
+
4. `Specifically, ...`
|
|
287
|
+
5. `In contrast to previous methods, ...`
|
|
288
|
+
6. `Another advantage of the proposed method is that ...`
|
|
289
|
+
|
|
290
|
+
Local cite:
|
|
291
|
+
|
|
292
|
+
1. `references/examples/introduction/pipeline-version-1-one-contribution-multi-advantages.md`
|
|
293
|
+
|
|
294
|
+
### Pipeline Version 2
|
|
295
|
+
|
|
296
|
+
`Version 2: Two contributions, and one teaser figure to present the basic idea.`
|
|
297
|
+
|
|
298
|
+
Writing structure:
|
|
299
|
+
|
|
300
|
+
1. Introduce framework and key novelty sentence.
|
|
301
|
+
2. Point to teaser figure.
|
|
302
|
+
3. Explain contribution 1 and its advantage.
|
|
303
|
+
4. Introduce a remaining challenge.
|
|
304
|
+
5. Explain contribution 2 as the response to that challenge.
|
|
305
|
+
|
|
306
|
+
Sentence skeleton:
|
|
307
|
+
|
|
308
|
+
1. `In this paper, we propose ...`
|
|
309
|
+
2. `Our innovation is in ...`
|
|
310
|
+
3. `The basic idea is illustrated in Figure ...`
|
|
311
|
+
4. `Specifically, ...` (contribution 1)
|
|
312
|
+
5. `In contrast to previous methods, ...`
|
|
313
|
+
6. `However, ...` (remaining challenge)
|
|
314
|
+
7. `Specifically, ...` (contribution 2)
|
|
315
|
+
|
|
316
|
+
Local cite:
|
|
317
|
+
|
|
318
|
+
1. `references/examples/introduction/pipeline-version-2-two-contributions.md`
|
|
319
|
+
|
|
320
|
+
### Pipeline Version 3
|
|
321
|
+
|
|
322
|
+
`Version 3: Build on a prior pipeline and introduce one new module, with a teaser figure for the basic idea.`
|
|
323
|
+
|
|
324
|
+
Writing structure:
|
|
325
|
+
|
|
326
|
+
1. Start from prior pipeline setup.
|
|
327
|
+
2. Introduce one new module as key innovation.
|
|
328
|
+
3. Provide an observation that motivates the module design.
|
|
329
|
+
4. Explain the module mechanism.
|
|
330
|
+
5. Compare against generic alternatives and state why it is better.
|
|
331
|
+
|
|
332
|
+
Sentence skeleton:
|
|
333
|
+
|
|
334
|
+
1. `Inspired by previous methods, ...`
|
|
335
|
+
2. `Our innovation is introducing ...`
|
|
336
|
+
3. `We observe that ...`
|
|
337
|
+
4. `Considering that ..., we introduce ...`
|
|
338
|
+
5. `In contrast to ..., our module ...`
|
|
339
|
+
|
|
340
|
+
Local cite:
|
|
341
|
+
|
|
342
|
+
1. `references/examples/introduction/pipeline-version-3-new-module-on-existing-pipeline.md`
|
|
343
|
+
|
|
344
|
+
### Pipeline Version 4
|
|
345
|
+
|
|
346
|
+
`Version 4: Contribution comes from one important observation. Introduce key innovation first, then a listener-friendly observation as motivation, then method details, then benefits.`
|
|
347
|
+
|
|
348
|
+
Writing structure:
|
|
349
|
+
|
|
350
|
+
1. State key innovation first.
|
|
351
|
+
2. State one intuitive observation as motivation.
|
|
352
|
+
3. Explain implementation details.
|
|
353
|
+
4. Explain technical advantage and empirical gain.
|
|
354
|
+
|
|
355
|
+
Sentence skeleton:
|
|
356
|
+
|
|
357
|
+
1. `Our innovation is ...`
|
|
358
|
+
2. `We observe that ...`
|
|
359
|
+
3. `Considering that ..., we ...`
|
|
360
|
+
4. `This leads to ... and achieves ...`
|
|
361
|
+
|
|
362
|
+
Local cite:
|
|
363
|
+
|
|
364
|
+
1. `references/examples/introduction/pipeline-version-4-observation-driven.md`
|
|
365
|
+
|
|
366
|
+
### Not Recommended Writing
|
|
367
|
+
|
|
368
|
+
`Not recommended: If the method is simple, do not hide concrete method design in Introduction and only describe abstract insights to make the work look novel.`
|
|
369
|
+
|
|
370
|
+
Expert note:
|
|
371
|
+
|
|
372
|
+
1. In this template, the writing craft is about making a simple pipeline sound novel.
|
|
373
|
+
2. The key caution: people often make the pipeline steps sound novel, not the real insight.
|
|
374
|
+
3. In most cases this is not recommended. The better target is to clearly explain core contribution implementation in Introduction.
|
|
375
|
+
|
|
376
|
+
Why not recommended (writing structure warning):
|
|
377
|
+
|
|
378
|
+
1. Presenting only abstract insight without concrete pipeline steps weakens technical clarity.
|
|
379
|
+
2. Introducing many new terms without mechanism-level explanation creates a novelty illusion.
|
|
380
|
+
3. Reviewers may interpret this as shallow or incremental work.
|
|
381
|
+
|
|
382
|
+
Local cite:
|
|
383
|
+
|
|
384
|
+
1. `references/examples/introduction/pipeline-not-recommended-abstract-only.md`
|
|
385
|
+
|
|
386
|
+
## Example Bank
|
|
387
|
+
|
|
388
|
+
1. `references/examples/introduction-examples.md`
|
|
389
|
+
2. `references/examples/introduction/version-1-task-then-application.md`
|
|
390
|
+
3. `references/examples/introduction/version-2-application-first.md`
|
|
391
|
+
4. `references/examples/introduction/version-3-general-to-specific-setting.md`
|
|
392
|
+
5. `references/examples/introduction/version-4-open-with-challenge.md`
|
|
393
|
+
6. `references/examples/introduction/technical-challenge-version-1-existing-task.md`
|
|
394
|
+
7. `references/examples/introduction/technical-challenge-version-2-existing-task-insight-backed-by-traditional.md`
|
|
395
|
+
8. `references/examples/introduction/technical-challenge-version-3-novel-task.md`
|
|
396
|
+
9. `references/examples/introduction/pipeline-version-1-one-contribution-multi-advantages.md`
|
|
397
|
+
10. `references/examples/introduction/pipeline-version-2-two-contributions.md`
|
|
398
|
+
11. `references/examples/introduction/pipeline-version-3-new-module-on-existing-pipeline.md`
|
|
399
|
+
12. `references/examples/introduction/pipeline-version-4-observation-driven.md`
|
|
400
|
+
13. `references/examples/introduction/pipeline-not-recommended-abstract-only.md`
|
|
401
|
+
|
|
402
|
+
## Quick Quality Checklist
|
|
403
|
+
|
|
404
|
+
1. Does the first sentence of each paragraph state its message?
|
|
405
|
+
2. Does each paragraph carry one message only?
|
|
406
|
+
3. Are technical challenge, technical reason, and solved mechanism all explicit?
|
|
407
|
+
4. Are claims in Introduction aligned with experiment evidence?
|
|
408
|
+
5. Is terminology stable across all sections?
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
# Method Writing Guide
|
|
2
|
+
|
|
3
|
+
## Goal
|
|
4
|
+
|
|
5
|
+
Write the Method section clearly by following this sequence:
|
|
6
|
+
|
|
7
|
+
1. Answer key method-design questions.
|
|
8
|
+
2. Draw a pipeline figure sketch.
|
|
9
|
+
3. Write the method section step by step.
|
|
10
|
+
|
|
11
|
+
## Pre-Writing Questions
|
|
12
|
+
|
|
13
|
+
`Before writing Method, first answer: (1) what modules exist in the method, and (2) for each module, what is the workflow, why this module is needed, and why this module works.`
|
|
14
|
+
|
|
15
|
+
Recommended organization:
|
|
16
|
+
|
|
17
|
+
1. List all modules in the pipeline.
|
|
18
|
+
2. For each module, answer three questions:
|
|
19
|
+
|
|
20
|
+
- How does the module run?
|
|
21
|
+
- Why do we need this module?
|
|
22
|
+
- Why does this module work?
|
|
23
|
+
|
|
24
|
+
3. Organize answers as a mind map or a table for clarity.
|
|
25
|
+
|
|
26
|
+
## Method Writing Steps
|
|
27
|
+
|
|
28
|
+
`Method writing steps: (1) draw pipeline figure sketch, (2) map subsections from the sketch, (3) plan each subsection with motivation/design/advantages, (4) write module design first, (5) then add motivation and technical advantages.`
|
|
29
|
+
|
|
30
|
+
Step-by-step workflow:
|
|
31
|
+
|
|
32
|
+
1. Draw the pipeline figure sketch.
|
|
33
|
+
2. Use the sketch to organize Method subsection structure.
|
|
34
|
+
3. For each subsection, plan three parts: motivation, module design, and technical advantages.
|
|
35
|
+
4. Write module design first to build a concrete backbone.
|
|
36
|
+
5. Add motivation and technical advantages afterward.
|
|
37
|
+
|
|
38
|
+
## Three Elements of a Pipeline Module
|
|
39
|
+
|
|
40
|
+
`A pipeline module has three elements: Module design, Motivation of this module, and Technical advantages of this module.`
|
|
41
|
+
|
|
42
|
+
### 1) Module Design
|
|
43
|
+
|
|
44
|
+
Definition:
|
|
45
|
+
|
|
46
|
+
1. Describe representation/network/data-structure details.
|
|
47
|
+
2. Describe the forward process clearly: given input -> step 1 -> step 2 -> step 3 -> output.
|
|
48
|
+
|
|
49
|
+
### 2) Motivation of This Module
|
|
50
|
+
|
|
51
|
+
Definition:
|
|
52
|
+
|
|
53
|
+
1. Explain why this module is needed.
|
|
54
|
+
2. Use problem-driven logic: because problem X exists, we design module Y.
|
|
55
|
+
|
|
56
|
+
### 3) Technical Advantages of This Module
|
|
57
|
+
|
|
58
|
+
Definition:
|
|
59
|
+
|
|
60
|
+
1. Explain why this module has technical advantage over alternatives.
|
|
61
|
+
2. Tie advantage to measurable behavior when possible.
|
|
62
|
+
|
|
63
|
+
### Example of the Three Elements
|
|
64
|
+
|
|
65
|
+
Local cite:
|
|
66
|
+
|
|
67
|
+
1. `references/examples/method/example-of-the-three-elements.md`
|
|
68
|
+
|
|
69
|
+
## Method Content Decomposition
|
|
70
|
+
|
|
71
|
+
```mermaid
|
|
72
|
+
flowchart LR
|
|
73
|
+
A["Draw the technical pipeline figure"] --> B["Decompose Method content"]
|
|
74
|
+
B --> C1["Subsection 1 (Technical Module 1)"]
|
|
75
|
+
B --> C2["Subsection 2 (Technical Module 2)"]
|
|
76
|
+
B --> C3["Subsection 3 (Technical Module 3)"]
|
|
77
|
+
C1 --> D1["Motivation"]
|
|
78
|
+
C1 --> D2["Detailed design"]
|
|
79
|
+
C1 --> D3["Technical advantage"]
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## How to Write Module Design
|
|
83
|
+
|
|
84
|
+
`Module design usually has two parts: (1) describe specific data/network structures, and (2) describe forward process as input -> steps -> output.`
|
|
85
|
+
|
|
86
|
+
Writing structure:
|
|
87
|
+
|
|
88
|
+
1. Define key structures first (representation, network, data structure).
|
|
89
|
+
2. Write forward process in strict execution order.
|
|
90
|
+
3. End with output interpretation or purpose.
|
|
91
|
+
|
|
92
|
+
Sentence skeleton:
|
|
93
|
+
|
|
94
|
+
1. `We represent ... with ...`
|
|
95
|
+
2. `Given [input], we first ... then ... finally ...`
|
|
96
|
+
3. `This produces [output], which is used for ...`
|
|
97
|
+
|
|
98
|
+
Local cite:
|
|
99
|
+
|
|
100
|
+
1. `references/examples/method/module-design-instant-ngp.md`
|
|
101
|
+
|
|
102
|
+
## How to Write Module Motivation
|
|
103
|
+
|
|
104
|
+
`Module motivation is usually problem-driven: because a problem exists, we design xx to solve it.`
|
|
105
|
+
|
|
106
|
+
Typical opening sentences:
|
|
107
|
+
|
|
108
|
+
1. `A remaining problem/challenge is ...`
|
|
109
|
+
2. `However, we ...`
|
|
110
|
+
3. `Previous methods have difficulty in ...`
|
|
111
|
+
|
|
112
|
+
Local cite:
|
|
113
|
+
|
|
114
|
+
1. `references/examples/method/module-motivation-patterns.md`
|
|
115
|
+
|
|
116
|
+
## How to Check Whether Method is Easy to Understand
|
|
117
|
+
|
|
118
|
+
`Check method clarity from three levels: writing logic, paragraph writing, and sentence writing.`
|
|
119
|
+
|
|
120
|
+
### 1) Logic-level check
|
|
121
|
+
|
|
122
|
+
1. After finishing the paper, summarize the Method writing logic again.
|
|
123
|
+
2. Check whether this summarized logic is smooth and easy to follow.
|
|
124
|
+
|
|
125
|
+
### 2) Paragraph-level check
|
|
126
|
+
|
|
127
|
+
1. The first sentence of each paragraph should make readers immediately understand what this paragraph is about.
|
|
128
|
+
2. One paragraph should clearly deliver one message.
|
|
129
|
+
|
|
130
|
+
### 3) Sentence-level check
|
|
131
|
+
|
|
132
|
+
1. Carefully check whether the **motivation** of each sentence is explicit. Keep one thing clear to readers at all times: **why this sentence content is needed**.
|
|
133
|
+
2. Carefully check sentence-to-sentence flow.
|
|
134
|
+
3. Carefully check term consistency and avoid changing key terms back and forth.
|
|
135
|
+
|
|
136
|
+
## Method Section Skeleton
|
|
137
|
+
|
|
138
|
+
```latex
|
|
139
|
+
\section{Method}
|
|
140
|
+
% Overview
|
|
141
|
+
% Section 3.1
|
|
142
|
+
% Section 3.2
|
|
143
|
+
% Section 3.3
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
Local cite:
|
|
147
|
+
|
|
148
|
+
1. `references/examples/method/section-skeleton.md`
|
|
149
|
+
|
|
150
|
+
## Overview Subsection
|
|
151
|
+
|
|
152
|
+
`Overview should usually include: setting, core contribution, optional pipeline figure pointer, and a map of what each subsection contains.`
|
|
153
|
+
|
|
154
|
+
Writing structure:
|
|
155
|
+
|
|
156
|
+
1. One to two sentences for task setting.
|
|
157
|
+
2. One to two sentences for core contribution.
|
|
158
|
+
3. If pipeline/framework is novel, point to overview figure.
|
|
159
|
+
4. Tell readers what Section 3.1/3.2/3.3 covers.
|
|
160
|
+
|
|
161
|
+
Local cite:
|
|
162
|
+
|
|
163
|
+
1. `references/examples/method/overview-template.md`
|
|
164
|
+
|
|
165
|
+
## Section 3.1 and Other Module Subsections
|
|
166
|
+
|
|
167
|
+
`Basic subsection logic: (1) motivation of this module, (2) module forward process/module design, (3) technical advantages of this module.`
|
|
168
|
+
|
|
169
|
+
Local cite:
|
|
170
|
+
|
|
171
|
+
1. `references/examples/method/example-of-the-three-elements.md`
|
|
172
|
+
|
|
173
|
+
## Module Writing Pattern (Mermaid)
|
|
174
|
+
|
|
175
|
+
```mermaid
|
|
176
|
+
flowchart TB
|
|
177
|
+
M1["State module motivation (challenge)"] --> M2["Define module design (representation/network)"]
|
|
178
|
+
M2 --> M3["Describe forward process (input -> steps -> output)"]
|
|
179
|
+
M3 --> M4["Explain technical advantages and verifiable gains"]
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
## Implementation Details
|
|
183
|
+
|
|
184
|
+
`Implementation details include hyperparameters (e.g., layer count, feature dimensions), coordinate transforms/normalization, and other practical details. Put them near the end of Method or in a dedicated Implementation Details section.`
|
|
185
|
+
|
|
186
|
+
## Example Bank
|
|
187
|
+
|
|
188
|
+
1. `references/examples/method-examples.md`
|
|
189
|
+
2. `references/examples/method/pre-writing-questions.md`
|
|
190
|
+
3. `references/examples/method/module-triad-neural-body.md`
|
|
191
|
+
4. `references/examples/method/module-design-instant-ngp.md`
|
|
192
|
+
5. `references/examples/method/module-motivation-patterns.md`
|
|
193
|
+
6. `references/examples/method/section-skeleton.md`
|
|
194
|
+
7. `references/examples/method/overview-template.md`
|
|
195
|
+
8. `references/examples/method/example-of-the-three-elements.md`
|
|
196
|
+
9. `references/examples/method/method-writing-common-issues-note.md`
|