superlab 0.1.24 → 0.1.26
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 +8 -2
- package/README.zh-CN.md +8 -3
- package/lib/auto_contracts.cjs +4 -2
- package/lib/context.cjs +155 -13
- package/lib/i18n.cjs +89 -15
- package/lib/install.cjs +2 -0
- package/package-assets/claude/commands/lab-write.md +1 -1
- package/package-assets/claude/commands/lab.md +2 -1
- package/package-assets/codex/prompts/lab-write.md +1 -1
- package/package-assets/codex/prompts/lab.md +2 -1
- package/package-assets/shared/lab/.managed/scripts/validate_manuscript_delivery.py +175 -0
- package/package-assets/shared/lab/.managed/templates/artifact-status.md +28 -0
- package/package-assets/shared/lab/.managed/templates/final-report.md +0 -11
- package/package-assets/shared/lab/.managed/templates/paper-figure.tex +6 -0
- package/package-assets/shared/lab/.managed/templates/paper-references.bib +9 -0
- package/package-assets/shared/lab/.managed/templates/paper-table.tex +13 -0
- package/package-assets/shared/lab/context/auto-mode.md +2 -2
- package/package-assets/shared/lab/context/session-brief.md +1 -1
- package/package-assets/shared/lab/context/state.md +19 -13
- package/package-assets/shared/lab/context/workflow-state.md +19 -0
- package/package-assets/shared/lab/system/core.md +4 -2
- package/package-assets/shared/skills/lab/SKILL.md +19 -14
- package/package-assets/shared/skills/lab/references/paper-writing/examples/conclusion/conservative-claim-boundary.md +27 -0
- package/package-assets/shared/skills/lab/references/paper-writing/examples/conclusion-examples.md +16 -0
- package/package-assets/shared/skills/lab/references/paper-writing/examples/experiments/figure-placeholder-and-discussion.md +44 -0
- package/package-assets/shared/skills/lab/references/paper-writing/examples/experiments/main-results-and-ablation-latex.md +83 -0
- package/package-assets/shared/skills/lab/references/paper-writing/examples/experiments-examples.md +17 -0
- package/package-assets/shared/skills/lab/references/paper-writing/examples/index.md +12 -3
- package/package-assets/shared/skills/lab/references/paper-writing/examples/related-work/closest-prior-gap-template.md +20 -0
- package/package-assets/shared/skills/lab/references/paper-writing/examples/related-work/topic-comparison-template.md +24 -0
- package/package-assets/shared/skills/lab/references/paper-writing/examples/related-work-examples.md +17 -0
- package/package-assets/shared/skills/lab/references/paper-writing-integration.md +19 -10
- package/package-assets/shared/skills/lab/stages/report.md +5 -2
- package/package-assets/shared/skills/lab/stages/write.md +34 -1
- package/package.json +1 -1
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Main Results and Ablation LaTeX Example
|
|
2
|
+
|
|
3
|
+
This file is a complete paper-facing LaTeX example for the experiments section.
|
|
4
|
+
Reuse the structure, caption logic, and prose-to-table linkage. Replace the
|
|
5
|
+
placeholder methods, metrics, and values with the current project's evidence.
|
|
6
|
+
|
|
7
|
+
Source inspiration:
|
|
8
|
+
- full table/figure organization examples from
|
|
9
|
+
`guanyingc/latex_paper_writing_tips`
|
|
10
|
+
- full paper-source organization from
|
|
11
|
+
`evaluating-adversarial-robustness/adv-eval-paper`
|
|
12
|
+
|
|
13
|
+
## Main Results Table
|
|
14
|
+
|
|
15
|
+
```tex
|
|
16
|
+
\begin{table}[t]
|
|
17
|
+
\caption{Main benchmark results under the frozen evaluation protocol. Higher is better on all metrics.}
|
|
18
|
+
\label{tab:main-results}
|
|
19
|
+
\centering
|
|
20
|
+
\resizebox{0.92\linewidth}{!}{
|
|
21
|
+
\begin{tabular}{lccc}
|
|
22
|
+
\toprule
|
|
23
|
+
Method & AUUC $\uparrow$ & Qini $\uparrow$ & Calibration Error $\downarrow$ \\
|
|
24
|
+
\midrule
|
|
25
|
+
Strongest baseline & 0.1421 & 0.0873 & 0.0612 \\
|
|
26
|
+
Closest prior work & 0.1488 & 0.0915 & 0.0544 \\
|
|
27
|
+
Ours & \textbf{0.1564} & \textbf{0.0987} & \textbf{0.0418} \\
|
|
28
|
+
\bottomrule
|
|
29
|
+
\end{tabular}
|
|
30
|
+
}
|
|
31
|
+
\end{table}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Table message:
|
|
35
|
+
- `Does the proposed method beat the strongest baselines under the frozen protocol?`
|
|
36
|
+
|
|
37
|
+
## Ablation Table
|
|
38
|
+
|
|
39
|
+
```tex
|
|
40
|
+
\begin{table}[t]
|
|
41
|
+
\caption{Ablations that isolate which design choices create the gain.}
|
|
42
|
+
\label{tab:ablations}
|
|
43
|
+
\centering
|
|
44
|
+
\begin{tabular}{lc}
|
|
45
|
+
\toprule
|
|
46
|
+
Variant & AUUC $\uparrow$ \\
|
|
47
|
+
\midrule
|
|
48
|
+
Ours & \textbf{0.1564} \\
|
|
49
|
+
w/o structure module & 0.1497 \\
|
|
50
|
+
w/o calibration stage & 0.1510 \\
|
|
51
|
+
w/ shuffled auxiliary signal & 0.1458 \\
|
|
52
|
+
\bottomrule
|
|
53
|
+
\end{tabular}
|
|
54
|
+
\end{table}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Table message:
|
|
58
|
+
- `Which design choices create the gain, and which ones are neutral?`
|
|
59
|
+
|
|
60
|
+
## Experiments Section Stitching Example
|
|
61
|
+
|
|
62
|
+
```tex
|
|
63
|
+
\section{Experiments}
|
|
64
|
+
\label{sec:experiments}
|
|
65
|
+
|
|
66
|
+
Table~\ref{tab:main-results} answers the main ranking question: whether the full
|
|
67
|
+
method remains stronger than the closest prior work and the strongest practical
|
|
68
|
+
baseline under the frozen protocol. Our method achieves the best AUUC and Qini
|
|
69
|
+
while also reducing calibration error, which means the gain is not coming from
|
|
70
|
+
trading ranking quality against stability.
|
|
71
|
+
|
|
72
|
+
Table~\ref{tab:ablations} then asks a narrower mechanism question. Removing the
|
|
73
|
+
structure module causes the largest drop, so the main gain is tied to structured
|
|
74
|
+
signal modeling rather than to a generic increase in capacity. Removing the
|
|
75
|
+
calibration stage leads to a smaller but still visible drop, which supports the
|
|
76
|
+
claim that calibration improves final ranking quality without being the sole
|
|
77
|
+
driver of the result. The shuffled-signal variant acts as a negative control and
|
|
78
|
+
shows that the gain does not survive when the auxiliary information is broken.
|
|
79
|
+
|
|
80
|
+
One caveat is that the calibration gain may remain neutral on some benchmarks,
|
|
81
|
+
so the paper should not overclaim that every component helps equally on every
|
|
82
|
+
dataset.
|
|
83
|
+
```
|
package/package-assets/shared/skills/lab/references/paper-writing/examples/experiments-examples.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Experiments Example Patterns
|
|
2
|
+
|
|
3
|
+
Use these examples when turning validated results into paper-facing LaTeX assets.
|
|
4
|
+
The referenced files contain complete LaTeX environments and section-level prose
|
|
5
|
+
glue, not just checklists.
|
|
6
|
+
|
|
7
|
+
## Required Asset Pattern
|
|
8
|
+
|
|
9
|
+
1. Main results should live in a real `table` environment.
|
|
10
|
+
2. Ablations should live in a separate `table` environment.
|
|
11
|
+
3. Method and experiments should each have at least one figure placeholder with an explicit `Figure intent`.
|
|
12
|
+
4. Captions should explain the table or figure message briefly; longer interpretation belongs in prose.
|
|
13
|
+
|
|
14
|
+
## Example Files
|
|
15
|
+
|
|
16
|
+
- `examples/experiments/main-results-and-ablation-latex.md`
|
|
17
|
+
- `examples/experiments/figure-placeholder-and-discussion.md`
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Example Bank Index
|
|
2
2
|
|
|
3
|
-
Use this folder for concrete writing patterns
|
|
3
|
+
Use this folder for concrete writing patterns, complete LaTeX snippets, and
|
|
4
|
+
locally organized cite targets.
|
|
4
5
|
|
|
5
6
|
## Files
|
|
6
7
|
|
|
@@ -12,10 +13,18 @@ Use this folder for concrete writing patterns and locally organized cite targets
|
|
|
12
13
|
6. Introduction pipeline files: `references/examples/introduction/pipeline-version-1-one-contribution-multi-advantages.md`, `references/examples/introduction/pipeline-version-2-two-contributions.md`, `references/examples/introduction/pipeline-version-3-new-module-on-existing-pipeline.md`, `references/examples/introduction/pipeline-version-4-observation-driven.md`, `references/examples/introduction/pipeline-not-recommended-abstract-only.md`
|
|
13
14
|
7. Method examples index: `references/examples/method-examples.md`
|
|
14
15
|
8. Method detail files: `references/examples/method/pre-writing-questions.md`, `references/examples/method/module-triad-neural-body.md`, `references/examples/method/neural-body-annotated-figure-text.md`, `references/examples/method/module-design-instant-ngp.md`, `references/examples/method/module-motivation-patterns.md`, `references/examples/method/section-skeleton.md`, `references/examples/method/overview-template.md`, `references/examples/method/example-of-the-three-elements.md`, `references/examples/method/method-writing-common-issues-note.md`
|
|
16
|
+
9. Related work examples index: `references/examples/related-work-examples.md`
|
|
17
|
+
10. Related work files: `references/examples/related-work/closest-prior-gap-template.md`, `references/examples/related-work/topic-comparison-template.md`
|
|
18
|
+
11. Experiments examples index: `references/examples/experiments-examples.md`
|
|
19
|
+
12. Experiments files: `references/examples/experiments/main-results-and-ablation-latex.md`, `references/examples/experiments/figure-placeholder-and-discussion.md`
|
|
20
|
+
13. Conclusion examples index: `references/examples/conclusion-examples.md`
|
|
21
|
+
14. Conclusion files: `references/examples/conclusion/conservative-claim-boundary.md`
|
|
15
22
|
|
|
16
23
|
## Usage
|
|
17
24
|
|
|
18
25
|
1. Pick one template from a section guide.
|
|
19
26
|
2. Open the matching examples file.
|
|
20
|
-
3.
|
|
21
|
-
|
|
27
|
+
3. Prefer the complete LaTeX examples when the section needs tables, figures,
|
|
28
|
+
citations, or section-level stitching.
|
|
29
|
+
4. Reuse the structure and command patterns, not exact wording.
|
|
30
|
+
5. Keep citation links in your notes for traceability.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Closest Prior Then Gap LaTeX Example
|
|
2
|
+
|
|
3
|
+
Use this example when one family of papers is the closest technical anchor and
|
|
4
|
+
the paragraph needs to explain the gap precisely.
|
|
5
|
+
|
|
6
|
+
```tex
|
|
7
|
+
\paragraph{Closest prior work.}
|
|
8
|
+
The closest prior line improves uplift ranking by sharpening the treatment-aware
|
|
9
|
+
scoring objective rather than by changing the final decision rule
|
|
10
|
+
itself~\cite{lee2021uplift,wang2022counterfactual}. These methods are strong
|
|
11
|
+
references because they already optimize for ranking quality and outperform
|
|
12
|
+
simple pointwise baselines on standard benchmarks. However, they still assume
|
|
13
|
+
that the learned score can be used directly as the final ranking signal across
|
|
14
|
+
datasets with different calibration behavior. That assumption is limiting in our
|
|
15
|
+
setting, where the raw score often contains useful relative information but is
|
|
16
|
+
not always aligned with the final protocol-level target. Our method keeps the
|
|
17
|
+
ranking-focused backbone but changes the final stage by inserting a post-hoc
|
|
18
|
+
calibration module, so the method can preserve the stronger internal signal
|
|
19
|
+
while adapting the exposed score to the benchmark-specific decision scale.
|
|
20
|
+
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Topic Comparison LaTeX Example
|
|
2
|
+
|
|
3
|
+
Use this example when the related-work section needs a compact, citation-driven
|
|
4
|
+
comparison paragraph rather than a bullet list of papers.
|
|
5
|
+
|
|
6
|
+
```tex
|
|
7
|
+
\paragraph{Structure-aware ranking methods.}
|
|
8
|
+
A second line of work improves ranking by injecting structured inductive bias
|
|
9
|
+
into the scoring function~\cite{smith2021structured,lee2022pairwise}. These
|
|
10
|
+
methods are attractive because they often stabilize training and can exploit
|
|
11
|
+
known relationships among samples or treatment groups. However, they typically
|
|
12
|
+
assume that the structured module alone is sufficient to produce well-calibrated
|
|
13
|
+
scores at evaluation time. In our setting, that assumption is too strong: the
|
|
14
|
+
raw ranking signal remains useful, but it is not always aligned with the final
|
|
15
|
+
decision scale required by the frozen protocol. We therefore keep the
|
|
16
|
+
structure-aware backbone but add a separate calibration stage, which lets us
|
|
17
|
+
reuse the stronger signal while correcting its final score mapping.
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
What this paragraph does:
|
|
21
|
+
1. groups one literature line by topic
|
|
22
|
+
2. states why the line is attractive
|
|
23
|
+
3. identifies the exact limitation that matters here
|
|
24
|
+
4. positions the current method as a narrower, testable change
|
package/package-assets/shared/skills/lab/references/paper-writing/examples/related-work-examples.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Related Work Example Patterns
|
|
2
|
+
|
|
3
|
+
Use these examples to structure `related work` around technical gaps instead of
|
|
4
|
+
citation dumping. The referenced files are complete citation-driven LaTeX
|
|
5
|
+
paragraph examples.
|
|
6
|
+
|
|
7
|
+
## Recommended Pattern
|
|
8
|
+
|
|
9
|
+
1. Open with the topic line.
|
|
10
|
+
2. Summarize 2-4 representative methods compactly.
|
|
11
|
+
3. State the exact limitation that matters for the current problem.
|
|
12
|
+
4. End with a transition sentence that positions the current method.
|
|
13
|
+
|
|
14
|
+
## Example Files
|
|
15
|
+
|
|
16
|
+
- `examples/related-work/closest-prior-gap-template.md`
|
|
17
|
+
- `examples/related-work/topic-comparison-template.md`
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
`/lab:write` vendors the paper-writing references directly into `skills/lab/references/paper-writing/`.
|
|
4
4
|
The goal is to keep the upstream writing discipline while removing brittle runtime dependence on a separately installed skill.
|
|
5
|
-
It also vendors the upstream example bank for the sections that currently have curated examples, so drafting can reuse concrete structure rather than only abstract guidance.
|
|
5
|
+
It also vendors the upstream example bank for the sections that currently have curated examples, and adds local manuscript-delivery examples for missing sections, so drafting can reuse concrete structure rather than only abstract guidance.
|
|
6
6
|
|
|
7
7
|
## Role Split
|
|
8
8
|
|
|
9
9
|
- `lab` controls stage boundaries, evidence discipline, and durable artifacts.
|
|
10
10
|
- the vendored paper-writing references control section structure, paragraph logic, and reviewer-facing polish.
|
|
11
|
-
- the vendored example bank controls example-driven structure selection for
|
|
11
|
+
- the vendored example bank controls example-driven structure selection for section prose and paper-facing LaTeX assets.
|
|
12
12
|
- `/lab:write` links evidence-backed research outputs to paper-ready text.
|
|
13
13
|
|
|
14
14
|
## Required Shared Constraints
|
|
@@ -41,26 +41,35 @@ It also vendors the upstream example bank for the sections that currently have c
|
|
|
41
41
|
- `paper-writing/examples/abstract-examples.md`
|
|
42
42
|
- `paper-writing/examples/introduction-examples.md`
|
|
43
43
|
- `paper-writing/examples/method-examples.md`
|
|
44
|
+
- `paper-writing/examples/related-work-examples.md`
|
|
45
|
+
- `paper-writing/examples/experiments-examples.md`
|
|
46
|
+
- `paper-writing/examples/conclusion-examples.md`
|
|
44
47
|
- `paper-writing/examples/abstract/*`
|
|
45
48
|
- `paper-writing/examples/introduction/*`
|
|
46
49
|
- `paper-writing/examples/method/*`
|
|
50
|
+
- `paper-writing/examples/related-work/*`
|
|
51
|
+
- `paper-writing/examples/experiments/*`
|
|
52
|
+
- `paper-writing/examples/conclusion/*`
|
|
47
53
|
|
|
48
54
|
## Write-Time Rule
|
|
49
55
|
|
|
50
|
-
For `abstract`, `introduction`, and `
|
|
56
|
+
For `abstract`, `introduction`, `method`, `related work`, `experiments`, and `conclusion`:
|
|
51
57
|
|
|
52
58
|
1. read the section guide first
|
|
53
|
-
2.
|
|
59
|
+
2. if the section has a bundled examples index, read it
|
|
54
60
|
3. read 1-2 concrete example files that match the intended structure
|
|
55
|
-
4. reuse structure
|
|
56
|
-
|
|
57
|
-
For `related work`, `experiments`, and `conclusion`:
|
|
58
|
-
|
|
59
|
-
1. use the section guide directly
|
|
60
|
-
2. do not invent non-existent example-bank files
|
|
61
|
+
4. reuse structure, sentence logic, and LaTeX asset patterns without copying wording
|
|
61
62
|
|
|
62
63
|
## Attribution
|
|
63
64
|
|
|
64
65
|
These references are adapted from:
|
|
65
66
|
|
|
66
67
|
- `https://github.com/Master-cai/Research-Paper-Writing-Skills/tree/main/research-paper-writing/references`
|
|
68
|
+
|
|
69
|
+
The local manuscript-delivery examples for missing sections are additionally informed by public LaTeX guidance and real paper-source repositories, including:
|
|
70
|
+
|
|
71
|
+
- `https://github.com/guanyingc/latex_paper_writing_tips`
|
|
72
|
+
- `https://github.com/evaluating-adversarial-robustness/adv-eval-paper`
|
|
73
|
+
- `https://github.com/lightningnetwork/paper`
|
|
74
|
+
|
|
75
|
+
These sources are used as structure references for complete LaTeX snippets, table/figure organization, and manuscript assembly patterns, so `/lab:write` can enforce tables, figure placeholders, and bibliography-ready drafts rather than prose-only section text.
|
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
- experiment setup
|
|
17
17
|
- validated main results
|
|
18
18
|
- managed main tables artifact under `<deliverables_root>/main-tables.md`
|
|
19
|
+
- internal artifact-status artifact under `<deliverables_root>/artifact-status.md`
|
|
19
20
|
- how-to-read-the-tables guide
|
|
20
21
|
- ablations
|
|
21
22
|
- failed attempts
|
|
@@ -27,6 +28,7 @@
|
|
|
27
28
|
|
|
28
29
|
- `.lab/context/mission.md`
|
|
29
30
|
- `.lab/context/state.md`
|
|
31
|
+
- `.lab/context/workflow-state.md`
|
|
30
32
|
- `.lab/context/decisions.md`
|
|
31
33
|
- `.lab/context/evidence-index.md`
|
|
32
34
|
- `.lab/context/data-decisions.md`
|
|
@@ -38,6 +40,7 @@
|
|
|
38
40
|
- `.lab/context/mission.md`
|
|
39
41
|
- `.lab/context/eval-protocol.md`
|
|
40
42
|
- `.lab/context/state.md`
|
|
43
|
+
- `.lab/context/workflow-state.md`
|
|
41
44
|
- `.lab/context/evidence-index.md`
|
|
42
45
|
|
|
43
46
|
## Evidence Rules
|
|
@@ -56,7 +59,7 @@
|
|
|
56
59
|
- When citing prior work or baselines in the method overview, include only the few anchor references a collaborator needs, and summarize their role and limitation in one short line each.
|
|
57
60
|
- Report only the few references a collaborator needs to orient themselves quickly; do not turn `report.md` into a full bibliography dump.
|
|
58
61
|
- In `Background Sources`, `Method and Baseline Sources`, and `Metric Sources`, every anchor must include a citation line, one short line about what it established or measures, and one limitation or caveat.
|
|
59
|
-
- Internal provenance belongs in `
|
|
62
|
+
- Internal provenance belongs in `<deliverables_root>/artifact-status.md` or `.lab/context/evidence-index.md`, not in the external-review-ready source sections.
|
|
60
63
|
- If the report depends on a deviation from an original metric or implementation, state that deviation explicitly instead of smoothing it over.
|
|
61
64
|
- Carry the approved `Claim boundary` into the collaborator-facing report instead of implying broader validity than the protocol allows.
|
|
62
65
|
- If the `Academic Validity Checks` or `Integrity self-check` sections are incomplete, contradictory, or obviously violated by the evidence, degrade the report instead of presenting it as collaborator-ready.
|
|
@@ -67,7 +70,7 @@
|
|
|
67
70
|
- If collaborator-critical fields still remain missing after hydration, downgrade the output to an `artifact-anchored interim report` instead of presenting it as a final collaborator-ready report.
|
|
68
71
|
- If the existing `report.md` or `main-tables.md` is missing required collaborator-facing sections from the managed templates, treat that as a report deficiency. A rerun must repair the missing sections instead of declaring "no content change" or treating the rerun as a no-op.
|
|
69
72
|
- After drafting or rerunning the report, run `.lab/.managed/scripts/validate_collaborator_report.py --report <deliverables_root>/report.md --main-tables <deliverables_root>/main-tables.md`. If it fails, keep editing until it passes; do not stop at a no-op audit rerun.
|
|
70
|
-
- Do not mix workflow deliverable status, rerun ids, or manuscript skeleton status into validated scientific findings; keep those in
|
|
73
|
+
- Do not mix workflow deliverable status, rerun ids, or manuscript skeleton status into validated scientific findings; keep those in `<deliverables_root>/artifact-status.md`.
|
|
71
74
|
- If `.lab/config/workflow.json` sets the workflow language to Chinese, write `report.md` and `<deliverables_root>/main-tables.md` in Chinese unless a file path, code identifier, or literal metric name must remain unchanged.
|
|
72
75
|
- Prefer conservative interpretation over marketing language.
|
|
73
76
|
- Leave a clear handoff path into `/lab:write` with evidence links that section drafts can cite.
|
|
@@ -45,6 +45,9 @@ When the current target has a bundled example bank, load the examples index and
|
|
|
45
45
|
- abstract -> `skills/lab/references/paper-writing/examples/index.md`, `skills/lab/references/paper-writing/examples/abstract-examples.md`, plus one matching file under `skills/lab/references/paper-writing/examples/abstract/`
|
|
46
46
|
- introduction -> `skills/lab/references/paper-writing/examples/index.md`, `skills/lab/references/paper-writing/examples/introduction-examples.md`, plus 1-2 matching files under `skills/lab/references/paper-writing/examples/introduction/`
|
|
47
47
|
- method -> `skills/lab/references/paper-writing/examples/index.md`, `skills/lab/references/paper-writing/examples/method-examples.md`, plus 1-2 matching files under `skills/lab/references/paper-writing/examples/method/`
|
|
48
|
+
- related work -> `skills/lab/references/paper-writing/examples/index.md`, `skills/lab/references/paper-writing/examples/related-work-examples.md`, plus 1-2 matching files under `skills/lab/references/paper-writing/examples/related-work/`
|
|
49
|
+
- experiments -> `skills/lab/references/paper-writing/examples/index.md`, `skills/lab/references/paper-writing/examples/experiments-examples.md`, plus 1-2 matching files under `skills/lab/references/paper-writing/examples/experiments/`
|
|
50
|
+
- conclusion -> `skills/lab/references/paper-writing/examples/index.md`, `skills/lab/references/paper-writing/examples/conclusion-examples.md`, plus 1-2 matching files under `skills/lab/references/paper-writing/examples/conclusion/`
|
|
48
51
|
|
|
49
52
|
Run these on every round:
|
|
50
53
|
|
|
@@ -61,17 +64,42 @@ Run these on every round:
|
|
|
61
64
|
- If the user chooses the default scaffold, persist that choice in `.lab/config/workflow.json` by setting `paper_template_decision` to `default-scaffold`.
|
|
62
65
|
- If the user chooses to attach a template, stop the drafting loop and route to `superlab paper attach-template --path <dir>` instead of silently falling back.
|
|
63
66
|
- If `paper_template_decision` is `default-scaffold`, use the managed default LaTeX scaffold under the deliverable paper directory.
|
|
67
|
+
- When using the managed default scaffold, use the managed paper asset templates as the starting point for new manuscript assets:
|
|
68
|
+
- `.lab/.managed/templates/paper.tex`
|
|
69
|
+
- `.lab/.managed/templates/paper-section.tex`
|
|
70
|
+
- `.lab/.managed/templates/paper-table.tex`
|
|
71
|
+
- `.lab/.managed/templates/paper-figure.tex`
|
|
72
|
+
- `.lab/.managed/templates/paper-references.bib`
|
|
64
73
|
- If the current round is a final manuscript export or final-draft pass, `paper_template_root` is still empty, `paper_template_decision` is `default-scaffold`, and `paper_template_final_reminder_acknowledged` is `false`, ask one final reminder question about switching to a template before finalizing.
|
|
65
74
|
- If the user confirms staying on the default scaffold at that final reminder, persist `paper_template_final_reminder_acknowledged: true`.
|
|
66
75
|
- Load only the current section guide. Do not load every section guide at once.
|
|
67
|
-
- Reuse example-bank structure, paragraph roles,
|
|
76
|
+
- Reuse example-bank structure, paragraph roles, sentence logic, and paper-facing LaTeX asset patterns when examples are bundled, but never copy wording verbatim.
|
|
68
77
|
- Treat example cites and example file names as writing references, not as evidence for the current paper.
|
|
69
78
|
- Build a compact mini-outline before prose.
|
|
79
|
+
- Build the paper asset plan before prose when the section carries experimental or method claims:
|
|
80
|
+
- decide which tables the section needs
|
|
81
|
+
- decide which figure placeholders the section needs
|
|
82
|
+
- decide which citations must appear in the section
|
|
70
83
|
- For each subsection, explicitly include motivation, design, and technical advantage when applicable.
|
|
71
84
|
- Avoid a writing style that reads like incremental patching of a naive baseline.
|
|
72
85
|
- Keep terminology stable across the full paper.
|
|
73
86
|
- Tie every new or revised claim to explicit evidence.
|
|
74
87
|
- If a claim cannot be supported by results, weaken or remove it.
|
|
88
|
+
- Do not treat section prose alone as a completed manuscript round.
|
|
89
|
+
- For paper-facing final drafts, maintain a non-empty `references.bib` with real citation keys instead of TODO placeholders.
|
|
90
|
+
- Keep paper-facing LaTeX free of absolute local paths, shell logs, rerun ids, and workflow-only provenance.
|
|
91
|
+
- Replace raw engineering notation such as `+/-` with proper LaTeX formatting such as `\pm`.
|
|
92
|
+
- If the current paper contains experimental claims, materialize real LaTeX table assets instead of leaving all results in prose:
|
|
93
|
+
- `<deliverables_root>/paper/tables/main-results.tex`
|
|
94
|
+
- `<deliverables_root>/paper/tables/ablations.tex`
|
|
95
|
+
- If the current paper contains method or experiments claims, materialize figure placeholders with captions, labels, and explicit figure intent:
|
|
96
|
+
- `<deliverables_root>/paper/figures/method-overview.tex`
|
|
97
|
+
- `<deliverables_root>/paper/figures/results-overview.tex`
|
|
98
|
+
- Table assets must use paper-facing LaTeX structure with `booktabs`, caption, label, and consistent precision.
|
|
99
|
+
- Figure placeholders must explain what the final figure should show and why the reader needs it.
|
|
100
|
+
- Run `.lab/.managed/scripts/validate_manuscript_delivery.py --paper-dir <deliverables_root>/paper` before accepting a final-draft or export round.
|
|
101
|
+
- If the manuscript validator fails, keep editing and asset generation until it passes; do not stop at prose-only completion.
|
|
102
|
+
- Run a LaTeX compile smoke test when a local LaTeX toolchain is available; if not available, record the missing verification in the write iteration artifact.
|
|
75
103
|
- Record what changed and why in a write-iteration artifact.
|
|
76
104
|
- Return paragraph-level roles for the revised prose when drafting.
|
|
77
105
|
- Run the five-dimension self-review checklist before accepting a round.
|
|
@@ -85,7 +113,12 @@ Run these on every round:
|
|
|
85
113
|
- `.lab/writing/plan.md`
|
|
86
114
|
- `.lab/writing/iterations/<n>.md`
|
|
87
115
|
- `<deliverables_root>/paper/main.tex`
|
|
116
|
+
- `<deliverables_root>/paper/references.bib`
|
|
88
117
|
- `<deliverables_root>/paper/sections/<section>.tex`
|
|
118
|
+
- `<deliverables_root>/paper/tables/main-results.tex`
|
|
119
|
+
- `<deliverables_root>/paper/tables/ablations.tex`
|
|
120
|
+
- `<deliverables_root>/paper/figures/method-overview.tex`
|
|
121
|
+
- `<deliverables_root>/paper/figures/results-overview.tex`
|
|
89
122
|
|
|
90
123
|
## Stop Conditions
|
|
91
124
|
|