拓冰网站定制 
构建 Distill 风格的现代化科研论文HuggingFace Paper Publisher 的 Modern 模板深度解析与实战指南【免费下载链接】skillsGive your agents the power of the Hugging Face ecosystem项目地址: https://gitcode.com/GitHub_Trending/skills7/skills导读在 Hugging Face Hub 上发布研究论文时一份结构规范、视觉友好、便于在网页端阅读的稿件能显著提升研究成果的可读性与传播效果。本指南以skills/huggingface-paper-publisher技能包内置的Modern 论文模板templates/modern.md为核心逐段拆解其 YAML 元数据、章节骨架、语义化 div 组件与内嵌样式体系并结合 paper_manager.py 的占位符渲染机制给出从生成、填充到转换为 HTML 的完整实战流程。读完本文你将能够使用一条命令快速生成具备 Distill 风格排版、含摘要框/关键洞察/实验结果等现代科研阅读元素的论文初稿并对其中的每一项设计取舍知其然、更知其所以然。一、Modern 模板在整个论文发布技能中的定位在动手使用模板之前先明确它在技能包中的位置。huggingface-paper-publisher技能的核心目标是在 Hugging Face Hub 上发布、管理并与模型/数据集建立关联的研究论文其整体能力由主文档 SKILL.md 定义包括Paper Page 管理从 arXiv 索引论文、认领作者身份、控制论文在个人主页的可见性模型/数据集/Spaces 关联通过 README 中的 arXiv 链接自动生成arxiv:PAPER_ID标签串联论文与制品研究文章生成基于 Markdown 模板输出专业排版论文并支持转换为网页版 HTML。其中研究文章生成正是 Modern 模板的用武之地。技能包共提供四套模板全部位于 templates/ 目录下模板文件定位风格特征modern.md现代网页友好排版受 Distill 与现代科学出版物启发带语义化 div 组件与内嵌 CSSstandard.md传统学术论文经典的分节编号结构1. Introduction / 2. Related Work / …arxiv.mdarXiv 期刊风格罗马数字章节、LaTeX 公式、Algorithm 伪代码、IEEE 式表格ml-report.md机器学习实验报告Executive Summary、数据/模型/训练/部署全流程的工程化记录Modern 模板的独特价值在于它不追求期刊投稿式的形式感而是面向Web 阅读体验——用div语义组件将摘要、关键洞察、定义、局限、结论等要素视觉化地强调出来配合响应式设计让读者在浏览器里像阅读 Distill 文章一样快速抓住研究重点。它也是四套模板中唯一将样式表直接内嵌进 Markdown 文档的模板适合最终以 HTML 形式分享的场景。二、模板的 YAML Frontmatter论文元数据的入口Modern 模板以 YAML Frontmatter 开头这是模板与渲染引擎以及 Hugging Face 卡片体系交互的元数据层。完整结构如下--- title: {{TITLE}} authors: {{AUTHORS}} date: {{DATE}} arxiv: tags: [machine-learning, ai] layout: modern ---各字段的含义与注意点title论文标题。在生成时由create命令的--title参数注入authors作者列表建议使用逗号分隔的FirstName LastName格式由--authors参数注入date日期。生成时会被自动填充为执行命令当天的日期格式为YYYY-MM-DD由 paper_manager.py 中的datetime.now().strftime(%Y-%m-%d)生成arxivarXiv 编号占位字段。提交 arXiv 拿到编号后可回填用于建立与 Paper Page 的关联tags主题标签默认[machine-learning, ai]可扩展为[nlp, fine-tuning, vision]等更精确的主题词layout值为modern标记本文使用现代排版布局。值得注意的细节是模板中的{{TITLE}}、{{AUTHORS}}、{{DATE}}是双花括号占位符并非最终内容。它们由create_research_article()方法在运行时统一替换见下文第五节。由于 Frontmatter 属于 YAML 语境、正文属于 Markdown 语境paper_manager.py 在实现上会先拆分 Frontmatter 与正文再分别做不同策略的转义在 Frontmatter 中作者/标题值通过_escape_yaml_value()包裹双引号并转义内部引号与反斜杠防止构造出非法 YAML 或注入额外字段见 paper_manager.py在正文中标题、作者、摘要通过_sanitize_text()做安全清洗去除控制字符、折叠多余空白、中和 Markdown 代码围栏与行首---分隔符避免外部输入破坏文章结构见 paper_manager.py。这套上下文感知转义机制保证了即使标题或作者中包含特殊字符生成的论文 Markdown 也不会语法崩溃。三、文档头部Header标题、作者与资源链接区Frontmatter 之后模板用一组div classheader组织论文的门面信息div classheader # {{TITLE}} div classauthors {{AUTHORS}} /div div classdate {{DATE}} /div div classlinks [arXiv](#) · [PDF](#) · [Code](#) · [Demo](#) /div /div这一部分的设计意图非常清晰# {{TITLE}}使用一级标题输出论文名确保在页面中占据最高的视觉层级.authors与.date两个 div 分别承载作者列表与日期通过 CSS 控制字号与颜色见第九节的样式表.links为读者提供arXiv · PDF · Code · Demo四个资源入口。模板中默认是#占位符实际使用时应当替换为论文的真实链接。这四项与技能包的可复现性理念一脉相承——模型权重放 Hugging Face、数据集放 HF Datasets、演示放 HF Spaces论文页面则通过 Paper Page 统一索引。从源码视角看这个 header 区块与技能包中Link Papers to Artifacts的能力是配套的模板负责在稿件里预留资源链接位而paper_manager.py link命令负责把 arXiv 论文与实际仓库model / dataset / space建立真实可点击的关联。四、核心章节骨架一篇现代论文的完整叙事线Modern 模板的主体部分按摘要 → 背景 → 方法 → 实验 → 消融 → 讨论 → 相关工作 → 结论 → 可复现性 → 致谢 → 附录的顺序展开每一节都附有撰写提示起到写作脚手架的作用。下面逐节解读。4.1 Abstract用语义化摘要框强调核心内容## Abstract div classabstract {{ABSTRACT}} /div{{ABSTRACT}}由create命令的--abstract参数注入若未提供会被替换为占位文本Abstract to be written...见 paper_manager.py。.abstract组件在样式中被赋予浅灰背景与圆角边框使摘要从正文中浮出便于快速扫读。4.2 Introduction关键洞察先行引言部分遵循结论前置的现代写作原则## Introduction Modern research requires clear, accessible communication. This template provides a clean, web-friendly format inspired by Distill and modern scientific publications. div classkey-insight **Key Insight**: Present your main contribution upfront to engage readers immediately. /div ### Why This Matters Explain the significance of your work in plain language. What real-world problems does it solve? ### Our Approach Summarize your methodology at a high level before diving into details.三处设计要点.key-insight关键洞察框蓝色左边框 浅蓝背景见样式表.key-insight专门用来放置全文最核心的一句话贡献让读者在 10 秒内确认这篇论文讲了什么Why This Matters引导作者用平实的语言说明研究价值——解决什么现实问题Our Approach要求作者在展开细节之前先给出方法的高层概述符合摘要 → 引言 → 方法的渐进式叙事节奏。4.3 Background定义与问题形式化## Background div classdefinition **Definition**: Clearly define key terms and concepts early in the paper. /div Provide context necessary to understand your contribution without overwhelming readers with details. ### Problem Statement Formally state the problem youre addressing. ### Challenges What makes this problem difficult? 1. **Challenge 1**: Description 2. **Challenge 2**: Description 3. **Challenge 3**: Description.definition组件使用橙色左边框与浅橙背景专门承载关键术语定义帮助读者在进入方法细节前统一术语口径。Challenges小节则提供了一份编号列表骨架Challenge 1/2/3用来陈述问题的难点来源为后文方法的针对性做铺垫。4.4 Method架构图 伪代码 训练策略方法章节是论文的技术核心Modern 模板为其提供了三种表达载体1架构图占位.figurediv classfigure[Diagram of your architecture goes here]**Figure 1**: Overview of the proposed method. Caption explains the key components. /div.figure组件将插图居中并约定使用Figure 1 图注的规范格式保证图表编号体系在成稿后依然整洁。2模型架构伪代码# Pseudocode example class YourModel: def __init__(self): self.encoder Encoder() self.decoder Decoder() def forward(self, x): z self.encoder(x) output self.decoder(z) return output模板直接给出一个 encoder-decoder 结构的 Python 伪代码示例作为如何描述模型系统组件的模板示范。该代码块在转换为 HTML 后支持语法高亮见 SKILL.md 中 Modern Template Features 所列能力。3Training Strategy 训练策略### Training Strategy Explain how you train the model, including: - **Objective Function**: Mathematical formulation - **Optimization**: Algorithm and hyperparameters - **Regularization**: Techniques to prevent overfitting训练策略被拆成目标函数、优化算法与超参数、正则化三个维度强制作者把怎么训讲清楚——这与技能包可复现性优先的整体主张一致。4.5 Experiments实验配置、结果表与洞察实验部分提供了一套完整的结构化工具Setup.experiment-details——用表格统一记录数据集、硬件、框架与训练耗时ComponentConfigurationDatasetName, Size, SplitHardwareGPU Type, RAMFrameworkPyTorch 2.0, TransformersTraining TimeHours/DaysResults.results-table——主结果表模板且预设了 Baseline /Ours/ SOTA 的三行对比结构ModelAccuracyF1 ScoreParamsSpeedBaseline85.2%0.84100M100 tok/sOurs92.1%0.91120M95 tok/sSOTA90.5%0.89300M60 tok/s紧随其后的.insight洞察框.insight与.key-insight共用蓝色样式用来写对结果的定性解读div classinsight **Observation**: Our method achieves state-of-the-art performance with fewer parameters. /divAnalysis——从 Performance对比结论、Efficiency计算成本、Robustness跨场景表现三个角度引导深入分析。4.6 Ablation Study组件贡献的量化归因div classablation-results | Configuration | Score | Δ | |---------------|-------|---| | Full Model | 92.1% | - | | - Component A | 89.3% | -2.8% | | - Component B | 90.1% | -2.0% | | - Component C | 91.5% | -0.6% | /div **Conclusion**: All components contribute meaningfully, with Component A being most critical.消融表格采用完整模型 逐个移除组件的行结构并带 Δ 增量列让每个组件的边际贡献一目了然结论行则要求用一句话点明哪个组件最关键。4.7 Discussion反思、局限与展望讨论章节由三部分组成What We Learned从实验中提炼综合洞察Limitations.limitations组件红色左边框 浅红背景用于坦诚列出方法缺陷例如性能在某领域受限、计算需求高、依赖大规模训练数据等div classlimitations ⚠️ **Current Limitations**: 1. Performance on domain X is limited 2. Computational requirements are high 3. Requires large training datasets /divFuture Directions给出社区后续可以探索的方向Direction 1/2/3。4.8 Related Work对比表格 差异化声明### Prior Approaches | Method | Year | Key Idea | Limitation | |--------|------|----------|------------| | Method A | 2020 | Approach 1 | Issue X | | Method B | 2021 | Approach 2 | Issue Y | | Method C | 2023 | Approach 3 | Issue Z | ### How We Differ Clearly articulate whats novel about your work.相关工作被组织为方法—年份—核心思想—局限四列对比表再用How We Differ一节强制作者明确我们的新意到底在哪。4.9 Conclusion贡献清单 结论框div classconclusion We presented **{{TITLE}}**, which achieves: 1. ✅ **Main contribution 1** 2. ✅ **Main contribution 2** 3. ✅ **Main contribution 3** Our results demonstrate [key finding], opening new directions for [future work]. /div.conclusion组件使用绿色左边框与浅绿背景以三项主要贡献 关键发现 未来方向收束全文。注意这里再次出现{{TITLE}}占位符渲染时同样会被自动替换为实际标题。4.10 Reproducibility可复现性区块div classreproducibility ### Code Data - **Code**: [github.com/username/repo](#) - **Models**: [huggingface.co/username/model](#) - **Datasets**: [huggingface.co/datasets/username/dataset](#) - **Demo**: [huggingface.co/spaces/username/demo](#) ### Citation bibtex article{yourpaper2025, title{{{{TITLE}}}}, author{{{{AUTHORS}}}}, year{2025}, journal{arXiv preprint} }.reproducibility组件灰色背景 圆角集中展示 Code / Models / Datasets / Demo 四个可复现入口并预置一份 BibTeX 引用模板。注意 BibTeX 内部使用了四重花括号{{{{TITLE}}}}——这是刻意设计的在create_research_article的占位符替换阶段{{TITLE}}会被替换为实际标题剩余的{{TITLE}}恰好构成 BibTeX 所需的双层花括号结构最终渲染出title{Your Paper Title}。这一细节体现了模板作者对模板引擎与输出格式双重转义的精细处理。此外paper_manager.py 还提供了citation子命令可直接根据 arXiv ID 自动生成标准 BibTeX 引用年份由 ID 前两位推导、作者与标题来自 arXiv API 并做花括号转义可用于替换或补充模板中的占位引用。4.11 Acknowledgments 与 AppendixAcknowledgments致谢资助机构、合作者与计算资源Appendix.appendix组件提供三个补充区块——A. Additional Results补充实验、B. Hyperparameters完整训练配置预置了 YAML 示例、C. Dataset Details数据集细节说明learning_rate: 1e-4 batch_size: 32 epochs: 100 optimizer: AdamW scheduler: cosine warmup_steps: 1000五、内嵌 CSS模板的排版引擎Modern 模板最显著的特点是在文件末尾内嵌了完整的style块定义了全文的视觉规范。逐条解读如下style .header { text-align: center; margin-bottom: 2em; } .authors { font-size: 1.2em; margin: 0.5em 0; } .date { color: #666; margin: 0.5em 0; } .links { margin-top: 1em; } .abstract { background: #f5f5f5; padding: 1.5em; border-radius: 8px; margin: 1em 0; } .key-insight, .insight { background: #e8f4f8; border-left: 4px solid #2196F3; padding: 1em; margin: 1em 0; } .definition { background: #fff3e0; border-left: 4px solid #ff9800; padding: 1em; margin: 1em 0; } .limitations { background: #ffebee; border-left: 4px solid #f44336; padding: 1em; margin: 1em 0; } .conclusion { background: #e8f5e9; border-left: 4px solid #4caf50; padding: 1.5em; margin: 1em 0; } .figure { text-align: center; margin: 2em 0; } .experiment-details, .results-table, .ablation-results { margin: 1em 0; } .reproducibility { background: #f5f5f5; padding: 1.5em; border-radius: 8px; margin: 2em 0; } /style这套样式有几个值得学习的工程点语义组件 统一视觉语言摘要灰、洞察蓝、定义橙、局限红、结论绿五类信息使用不同的背景色与 4px 左边框形成颜色即语义的阅读导航读者无需寻找就能定位重点段落组件类与 Markdown 结构解耦样式通过.experiment-details、.results-table、.ablation-results等类名作用于表格容器而表格本身仍是标准 Markdown 表格因此即使纯文本环境下内容依然可读转换为 HTML 后则获得额外样式响应式友好全文使用相对单位em与弹性布局适配桌面与移动端阅读。这也是 SKILL.md 中 Modern Template Features 所描述的响应式设计、动态目录、代码语法高亮、交互图表、LaTeX 公式渲染、引用管理、作者单位链接等能力的样式基础——其中动态 TOC 与代码高亮通常由最终渲染器如 Markdown→HTML 转换工具配合完成。六、从模板到论文create命令的完整用法理解模板结构后关键在于掌握如何把它实例化成真实论文。技能包通过 paper_manager.py 的create_research_article()方法完成这一过程。6.1 基础用法uv run scripts/paper_manager.py create \ --template modern \ --title Fine-Tuning Large Language Models with LoRA \ --authors Jane Doe, John Smith \ --abstract $(cat abstract.txt) \ --output paper.md其中--template modern指定使用本模板模板文件路径由源码从脚本所在目录向上回溯到templates/modern.md解析见 paper_manager.py--title、--authors、--abstract分别注入标题、作者与摘要--output指定输出文件名若省略--authors默认值为Your Name省略--abstract则填入Abstract to be written...日期由系统自动生成为当天。执行前提该脚本通过 PEP 723 在文件头声明内联依赖huggingface_hub、pyyaml、requests、python-dotenv推荐使用uv run自动解析依赖若需要执行link、index等涉及写操作的命令还需预先设置具备写权限的HF_TOKEN环境变量创建文章本身是纯本地文件操作不强制需要 token。6.2 渲染过程的源码级拆解create_research_article()的实现分四步见 paper_manager.py加载模板读取templates/modern.md全文准备安全值对标题、作者、摘要分别调用_sanitize_text()清洗日期格式化为YYYY-MM-DD拆分处理用正则^(---\s*\n)(.*?\n)(---\s*\n)将模板拆为 Frontmatter 与正文两部分——Frontmatter 中的{{TITLE}}、{{AUTHORS}}用_escape_yaml_value()做 YAML 转义{{DATE}}替换为日期正文中的{{TITLE}}、{{AUTHORS}}、{{ABSTRACT}}、{{DATE}}用_sanitize_text()处理写回文件将重组后的完整内容写入--output指定的文件。这意味着模板中其余章节的提示文案、表格骨架、div 组件与 CSS 会被原样保留作者只需替换提示内容即可。而 Reproducibility 中的 BibTeX 四重花括号{{{{TITLE}}}}经过替换后恰好输出合法的 BibTeX 双层花括号——这是模板与渲染逻辑协同设计的典型例证。6.3 四套模板的对比与选型从模板目录可以横向对比选型使用场景推荐模板理由在网页端分享、希望读者快速抓住要点modernDistill 风格语义组件 内嵌样式阅读体验最佳需要投递到传统会议/期刊格式standard经典分节编号与投稿模板的章节组织最接近需要展示大量公式与算法伪代码arxiv内置 LaTeX 公式块、Algorithm 环境和 IEEE 风格表格记录实验迭代过程而非正式论文ml-reportExecutive Summary 数据集/训练/部署全流程工程记录七、从 Markdown 到网页convert命令与发布链路生成 Markdown 论文后技能包支持将其转换为 HTML 以便在浏览器中分享uv run scripts/paper_manager.py convert \ --input paper.md \ --output paper.html \ --style modern--style modern对应本模板的现代排版风格。转换后的 HTML 会保留模板内嵌的 CSS 样式与 div 组件视觉效果配合渲染器实现动态目录、代码高亮与 LaTeX 公式显示。结合技能包的完整工作流一篇 Modern 风格论文的典型发布路径是详见 SKILL.md 中的集成示例# 1. 基于 modern 模板生成论文初稿 uv run scripts/paper_manager.py create \ --template modern \ --title Novel Fine-Tuning Approach \ --authors Jane Doe, John Smith \ --output paper.md # 2. 编辑 paper.md填入真实内容、替换资源链接 # 3. 提交 arXiv 并取得 arXiv ID外部流程 # 4. 在 Hugging Face 上索引论文 uv run scripts/paper_manager.py index --arxiv-id 2301.12345 # 5. 将论文关联到模型/数据集仓库 uv run scripts/paper_manager.py link \ --repo-id your-username/your-model \ --repo-type model \ --arxiv-id 2301.12345 # 6. 认领作者身份 uv run scripts/paper_manager.py claim \ --arxiv-id 2301.12345 \ --email your.emailedu其中link命令的底层逻辑见 paper_manager.py会下载目标仓库 README、解析或创建 YAML Frontmatter、在正文插入带边界标记!-- paper-manager:start --的论文引用区与 BibTeX 引用然后通过api.upload_file上传Hub 端会自动生成arxiv:PAPER_ID标签。这一系列操作让论文稿件与Hub 上的制品真正形成闭环。八、最佳实践与常见问题8.1 使用 Modern 模板的最佳实践综合模板设计意图与 examples/example_usage.md 中的建议关键洞察要前置在.key-insight框内用一句话写清核心贡献这是现代论文吸引读者停留的关键表格骨架直接复用Setup / Results / Ablation 的表格结构已经过设计只需替换为真实数据并保持 Baseline / Ours / SOTA 的对比结构资源链接务必补齐正文写完后再回头检查 header 区的 arXiv / PDF / Code / Demo 链接以及 Reproducibility 区的 Code / Models / Datasets / Demo 四项它们共同决定论文的可复现性统一模板使用同一研究组内的论文尽量统一采用modern模板保持对外呈现的一致性转换 HTML 分享将最终稿通过convert命令转为网页版便于在浏览器中快速阅读与传播。8.2 常见问题与排查生成的论文里仍是{{TITLE}}占位符说明渲染阶段替换失败请检查--title参数是否传入、paper_manager.py是否通过uv run正确加载内联依赖BibTeX 中花括号数量异常请勿手动修改模板中{{{{TITLE}}}}的四重花括号结构这是为渲染后输出合法 BibTeX 而设计的两级转义转换为 HTML 后组件样式丢失确认convert时--style参数与模板匹配modern 模板使用modern风格并检查 HTML 输出中是否保留了模板末尾的style块Link 操作报权限错误按 SKILL.md 的说明确认HF_TOKEN已设置且对目标仓库具备写权限创建文章本身为本地操作不受影响。九、总结Modern 模板是huggingface-paper-publisher技能包中面向网页阅读体验的现代论文排版方案。它通过 YAML Frontmatter 承载元数据、用语义化 div 组件abstract / key-insight / definition / experiment-details / insight / ablation-results / limitations / conclusion / reproducibility / appendix构建颜色即语义的视觉导航再以内嵌 CSS 统一全文排版而 paper_manager.py 的占位符替换机制Frontmatter 走 YAML 转义、正文走 Markdown 安全清洗保证了生成过程的健壮性create/convert两条命令则完成了从模板实例化到网页输出的完整链路。无论是撰写新的研究成果还是为已有工作补齐规范的论文页面这条模板 → Markdown → HTML → Hub 发布的路径都能显著降低排版成本、提升成果的可读与可复现性。延伸阅读模板目录 templates/ 中的另外三套模板standard.md、arxiv.md、ml-report.md技能完整说明见 SKILL.md命令速查见 quick_reference.md完整工作流示例见 example_usage.md。【免费下载链接】skillsGive your agents the power of the Hugging Face ecosystem项目地址: https://gitcode.com/GitHub_Trending/skills7/skills创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 构建 Distill 风格的现代化科研论文：HuggingFace Paper Publisher 的 Modern 模板深度解析与实战指南
构建 Distill 风格的现代化科研论文HuggingFace Paper Publisher 的 Modern 模板深度解析与实战指南【免费下载链接】skillsGive your agents the power of the Hugging Face ecosystem项目地址: https://gitcode.com/GitHub_Trending/skills7/skills导读在 Hugging Face Hub 上发布研究论文时一份结构规范、视觉友好、便于在网页端阅读的稿件能显著提升研究成果的可读性与传播效果。本指南以skills/huggingface-paper-publisher技能包内置的Modern 论文模板templates/modern.md为核心逐段拆解其 YAML 元数据、章节骨架、语义化 div 组件与内嵌样式体系并结合 paper_manager.py 的占位符渲染机制给出从生成、填充到转换为 HTML 的完整实战流程。读完本文你将能够使用一条命令快速生成具备 Distill 风格排版、含摘要框/关键洞察/实验结果等现代科研阅读元素的论文初稿并对其中的每一项设计取舍知其然、更知其所以然。一、Modern 模板在整个论文发布技能中的定位在动手使用模板之前先明确它在技能包中的位置。huggingface-paper-publisher技能的核心目标是在 Hugging Face Hub 上发布、管理并与模型/数据集建立关联的研究论文其整体能力由主文档 SKILL.md 定义包括Paper Page 管理从 arXiv 索引论文、认领作者身份、控制论文在个人主页的可见性模型/数据集/Spaces 关联通过 README 中的 arXiv 链接自动生成arxiv:PAPER_ID标签串联论文与制品研究文章生成基于 Markdown 模板输出专业排版论文并支持转换为网页版 HTML。其中研究文章生成正是 Modern 模板的用武之地。技能包共提供四套模板全部位于 templates/ 目录下模板文件定位风格特征modern.md现代网页友好排版受 Distill 与现代科学出版物启发带语义化 div 组件与内嵌 CSSstandard.md传统学术论文经典的分节编号结构1. Introduction / 2. Related Work / …arxiv.mdarXiv 期刊风格罗马数字章节、LaTeX 公式、Algorithm 伪代码、IEEE 式表格ml-report.md机器学习实验报告Executive Summary、数据/模型/训练/部署全流程的工程化记录Modern 模板的独特价值在于它不追求期刊投稿式的形式感而是面向Web 阅读体验——用div语义组件将摘要、关键洞察、定义、局限、结论等要素视觉化地强调出来配合响应式设计让读者在浏览器里像阅读 Distill 文章一样快速抓住研究重点。它也是四套模板中唯一将样式表直接内嵌进 Markdown 文档的模板适合最终以 HTML 形式分享的场景。二、模板的 YAML Frontmatter论文元数据的入口Modern 模板以 YAML Frontmatter 开头这是模板与渲染引擎以及 Hugging Face 卡片体系交互的元数据层。完整结构如下--- title: {{TITLE}} authors: {{AUTHORS}} date: {{DATE}} arxiv: tags: [machine-learning, ai] layout: modern ---各字段的含义与注意点title论文标题。在生成时由create命令的--title参数注入authors作者列表建议使用逗号分隔的FirstName LastName格式由--authors参数注入date日期。生成时会被自动填充为执行命令当天的日期格式为YYYY-MM-DD由 paper_manager.py 中的datetime.now().strftime(%Y-%m-%d)生成arxivarXiv 编号占位字段。提交 arXiv 拿到编号后可回填用于建立与 Paper Page 的关联tags主题标签默认[machine-learning, ai]可扩展为[nlp, fine-tuning, vision]等更精确的主题词layout值为modern标记本文使用现代排版布局。值得注意的细节是模板中的{{TITLE}}、{{AUTHORS}}、{{DATE}}是双花括号占位符并非最终内容。它们由create_research_article()方法在运行时统一替换见下文第五节。由于 Frontmatter 属于 YAML 语境、正文属于 Markdown 语境paper_manager.py 在实现上会先拆分 Frontmatter 与正文再分别做不同策略的转义在 Frontmatter 中作者/标题值通过_escape_yaml_value()包裹双引号并转义内部引号与反斜杠防止构造出非法 YAML 或注入额外字段见 paper_manager.py在正文中标题、作者、摘要通过_sanitize_text()做安全清洗去除控制字符、折叠多余空白、中和 Markdown 代码围栏与行首---分隔符避免外部输入破坏文章结构见 paper_manager.py。这套上下文感知转义机制保证了即使标题或作者中包含特殊字符生成的论文 Markdown 也不会语法崩溃。三、文档头部Header标题、作者与资源链接区Frontmatter 之后模板用一组div classheader组织论文的门面信息div classheader # {{TITLE}} div classauthors {{AUTHORS}} /div div classdate {{DATE}} /div div classlinks [arXiv](#) · [PDF](#) · [Code](#) · [Demo](#) /div /div这一部分的设计意图非常清晰# {{TITLE}}使用一级标题输出论文名确保在页面中占据最高的视觉层级.authors与.date两个 div 分别承载作者列表与日期通过 CSS 控制字号与颜色见第九节的样式表.links为读者提供arXiv · PDF · Code · Demo四个资源入口。模板中默认是#占位符实际使用时应当替换为论文的真实链接。这四项与技能包的可复现性理念一脉相承——模型权重放 Hugging Face、数据集放 HF Datasets、演示放 HF Spaces论文页面则通过 Paper Page 统一索引。从源码视角看这个 header 区块与技能包中Link Papers to Artifacts的能力是配套的模板负责在稿件里预留资源链接位而paper_manager.py link命令负责把 arXiv 论文与实际仓库model / dataset / space建立真实可点击的关联。四、核心章节骨架一篇现代论文的完整叙事线Modern 模板的主体部分按摘要 → 背景 → 方法 → 实验 → 消融 → 讨论 → 相关工作 → 结论 → 可复现性 → 致谢 → 附录的顺序展开每一节都附有撰写提示起到写作脚手架的作用。下面逐节解读。4.1 Abstract用语义化摘要框强调核心内容## Abstract div classabstract {{ABSTRACT}} /div{{ABSTRACT}}由create命令的--abstract参数注入若未提供会被替换为占位文本Abstract to be written...见 paper_manager.py。.abstract组件在样式中被赋予浅灰背景与圆角边框使摘要从正文中浮出便于快速扫读。4.2 Introduction关键洞察先行引言部分遵循结论前置的现代写作原则## Introduction Modern research requires clear, accessible communication. This template provides a clean, web-friendly format inspired by Distill and modern scientific publications. div classkey-insight **Key Insight**: Present your main contribution upfront to engage readers immediately. /div ### Why This Matters Explain the significance of your work in plain language. What real-world problems does it solve? ### Our Approach Summarize your methodology at a high level before diving into details.三处设计要点.key-insight关键洞察框蓝色左边框 浅蓝背景见样式表.key-insight专门用来放置全文最核心的一句话贡献让读者在 10 秒内确认这篇论文讲了什么Why This Matters引导作者用平实的语言说明研究价值——解决什么现实问题Our Approach要求作者在展开细节之前先给出方法的高层概述符合摘要 → 引言 → 方法的渐进式叙事节奏。4.3 Background定义与问题形式化## Background div classdefinition **Definition**: Clearly define key terms and concepts early in the paper. /div Provide context necessary to understand your contribution without overwhelming readers with details. ### Problem Statement Formally state the problem youre addressing. ### Challenges What makes this problem difficult? 1. **Challenge 1**: Description 2. **Challenge 2**: Description 3. **Challenge 3**: Description.definition组件使用橙色左边框与浅橙背景专门承载关键术语定义帮助读者在进入方法细节前统一术语口径。Challenges小节则提供了一份编号列表骨架Challenge 1/2/3用来陈述问题的难点来源为后文方法的针对性做铺垫。4.4 Method架构图 伪代码 训练策略方法章节是论文的技术核心Modern 模板为其提供了三种表达载体1架构图占位.figurediv classfigure[Diagram of your architecture goes here]**Figure 1**: Overview of the proposed method. Caption explains the key components. /div.figure组件将插图居中并约定使用Figure 1 图注的规范格式保证图表编号体系在成稿后依然整洁。2模型架构伪代码# Pseudocode example class YourModel: def __init__(self): self.encoder Encoder() self.decoder Decoder() def forward(self, x): z self.encoder(x) output self.decoder(z) return output模板直接给出一个 encoder-decoder 结构的 Python 伪代码示例作为如何描述模型系统组件的模板示范。该代码块在转换为 HTML 后支持语法高亮见 SKILL.md 中 Modern Template Features 所列能力。3Training Strategy 训练策略### Training Strategy Explain how you train the model, including: - **Objective Function**: Mathematical formulation - **Optimization**: Algorithm and hyperparameters - **Regularization**: Techniques to prevent overfitting训练策略被拆成目标函数、优化算法与超参数、正则化三个维度强制作者把怎么训讲清楚——这与技能包可复现性优先的整体主张一致。4.5 Experiments实验配置、结果表与洞察实验部分提供了一套完整的结构化工具Setup.experiment-details——用表格统一记录数据集、硬件、框架与训练耗时ComponentConfigurationDatasetName, Size, SplitHardwareGPU Type, RAMFrameworkPyTorch 2.0, TransformersTraining TimeHours/DaysResults.results-table——主结果表模板且预设了 Baseline /Ours/ SOTA 的三行对比结构ModelAccuracyF1 ScoreParamsSpeedBaseline85.2%0.84100M100 tok/sOurs92.1%0.91120M95 tok/sSOTA90.5%0.89300M60 tok/s紧随其后的.insight洞察框.insight与.key-insight共用蓝色样式用来写对结果的定性解读div classinsight **Observation**: Our method achieves state-of-the-art performance with fewer parameters. /divAnalysis——从 Performance对比结论、Efficiency计算成本、Robustness跨场景表现三个角度引导深入分析。4.6 Ablation Study组件贡献的量化归因div classablation-results | Configuration | Score | Δ | |---------------|-------|---| | Full Model | 92.1% | - | | - Component A | 89.3% | -2.8% | | - Component B | 90.1% | -2.0% | | - Component C | 91.5% | -0.6% | /div **Conclusion**: All components contribute meaningfully, with Component A being most critical.消融表格采用完整模型 逐个移除组件的行结构并带 Δ 增量列让每个组件的边际贡献一目了然结论行则要求用一句话点明哪个组件最关键。4.7 Discussion反思、局限与展望讨论章节由三部分组成What We Learned从实验中提炼综合洞察Limitations.limitations组件红色左边框 浅红背景用于坦诚列出方法缺陷例如性能在某领域受限、计算需求高、依赖大规模训练数据等div classlimitations ⚠️ **Current Limitations**: 1. Performance on domain X is limited 2. Computational requirements are high 3. Requires large training datasets /divFuture Directions给出社区后续可以探索的方向Direction 1/2/3。4.8 Related Work对比表格 差异化声明### Prior Approaches | Method | Year | Key Idea | Limitation | |--------|------|----------|------------| | Method A | 2020 | Approach 1 | Issue X | | Method B | 2021 | Approach 2 | Issue Y | | Method C | 2023 | Approach 3 | Issue Z | ### How We Differ Clearly articulate whats novel about your work.相关工作被组织为方法—年份—核心思想—局限四列对比表再用How We Differ一节强制作者明确我们的新意到底在哪。4.9 Conclusion贡献清单 结论框div classconclusion We presented **{{TITLE}}**, which achieves: 1. ✅ **Main contribution 1** 2. ✅ **Main contribution 2** 3. ✅ **Main contribution 3** Our results demonstrate [key finding], opening new directions for [future work]. /div.conclusion组件使用绿色左边框与浅绿背景以三项主要贡献 关键发现 未来方向收束全文。注意这里再次出现{{TITLE}}占位符渲染时同样会被自动替换为实际标题。4.10 Reproducibility可复现性区块div classreproducibility ### Code Data - **Code**: [github.com/username/repo](#) - **Models**: [huggingface.co/username/model](#) - **Datasets**: [huggingface.co/datasets/username/dataset](#) - **Demo**: [huggingface.co/spaces/username/demo](#) ### Citation bibtex article{yourpaper2025, title{{{{TITLE}}}}, author{{{{AUTHORS}}}}, year{2025}, journal{arXiv preprint} }.reproducibility组件灰色背景 圆角集中展示 Code / Models / Datasets / Demo 四个可复现入口并预置一份 BibTeX 引用模板。注意 BibTeX 内部使用了四重花括号{{{{TITLE}}}}——这是刻意设计的在create_research_article的占位符替换阶段{{TITLE}}会被替换为实际标题剩余的{{TITLE}}恰好构成 BibTeX 所需的双层花括号结构最终渲染出title{Your Paper Title}。这一细节体现了模板作者对模板引擎与输出格式双重转义的精细处理。此外paper_manager.py 还提供了citation子命令可直接根据 arXiv ID 自动生成标准 BibTeX 引用年份由 ID 前两位推导、作者与标题来自 arXiv API 并做花括号转义可用于替换或补充模板中的占位引用。4.11 Acknowledgments 与 AppendixAcknowledgments致谢资助机构、合作者与计算资源Appendix.appendix组件提供三个补充区块——A. Additional Results补充实验、B. Hyperparameters完整训练配置预置了 YAML 示例、C. Dataset Details数据集细节说明learning_rate: 1e-4 batch_size: 32 epochs: 100 optimizer: AdamW scheduler: cosine warmup_steps: 1000五、内嵌 CSS模板的排版引擎Modern 模板最显著的特点是在文件末尾内嵌了完整的style块定义了全文的视觉规范。逐条解读如下style .header { text-align: center; margin-bottom: 2em; } .authors { font-size: 1.2em; margin: 0.5em 0; } .date { color: #666; margin: 0.5em 0; } .links { margin-top: 1em; } .abstract { background: #f5f5f5; padding: 1.5em; border-radius: 8px; margin: 1em 0; } .key-insight, .insight { background: #e8f4f8; border-left: 4px solid #2196F3; padding: 1em; margin: 1em 0; } .definition { background: #fff3e0; border-left: 4px solid #ff9800; padding: 1em; margin: 1em 0; } .limitations { background: #ffebee; border-left: 4px solid #f44336; padding: 1em; margin: 1em 0; } .conclusion { background: #e8f5e9; border-left: 4px solid #4caf50; padding: 1.5em; margin: 1em 0; } .figure { text-align: center; margin: 2em 0; } .experiment-details, .results-table, .ablation-results { margin: 1em 0; } .reproducibility { background: #f5f5f5; padding: 1.5em; border-radius: 8px; margin: 2em 0; } /style这套样式有几个值得学习的工程点语义组件 统一视觉语言摘要灰、洞察蓝、定义橙、局限红、结论绿五类信息使用不同的背景色与 4px 左边框形成颜色即语义的阅读导航读者无需寻找就能定位重点段落组件类与 Markdown 结构解耦样式通过.experiment-details、.results-table、.ablation-results等类名作用于表格容器而表格本身仍是标准 Markdown 表格因此即使纯文本环境下内容依然可读转换为 HTML 后则获得额外样式响应式友好全文使用相对单位em与弹性布局适配桌面与移动端阅读。这也是 SKILL.md 中 Modern Template Features 所描述的响应式设计、动态目录、代码语法高亮、交互图表、LaTeX 公式渲染、引用管理、作者单位链接等能力的样式基础——其中动态 TOC 与代码高亮通常由最终渲染器如 Markdown→HTML 转换工具配合完成。六、从模板到论文create命令的完整用法理解模板结构后关键在于掌握如何把它实例化成真实论文。技能包通过 paper_manager.py 的create_research_article()方法完成这一过程。6.1 基础用法uv run scripts/paper_manager.py create \ --template modern \ --title Fine-Tuning Large Language Models with LoRA \ --authors Jane Doe, John Smith \ --abstract $(cat abstract.txt) \ --output paper.md其中--template modern指定使用本模板模板文件路径由源码从脚本所在目录向上回溯到templates/modern.md解析见 paper_manager.py--title、--authors、--abstract分别注入标题、作者与摘要--output指定输出文件名若省略--authors默认值为Your Name省略--abstract则填入Abstract to be written...日期由系统自动生成为当天。执行前提该脚本通过 PEP 723 在文件头声明内联依赖huggingface_hub、pyyaml、requests、python-dotenv推荐使用uv run自动解析依赖若需要执行link、index等涉及写操作的命令还需预先设置具备写权限的HF_TOKEN环境变量创建文章本身是纯本地文件操作不强制需要 token。6.2 渲染过程的源码级拆解create_research_article()的实现分四步见 paper_manager.py加载模板读取templates/modern.md全文准备安全值对标题、作者、摘要分别调用_sanitize_text()清洗日期格式化为YYYY-MM-DD拆分处理用正则^(---\s*\n)(.*?\n)(---\s*\n)将模板拆为 Frontmatter 与正文两部分——Frontmatter 中的{{TITLE}}、{{AUTHORS}}用_escape_yaml_value()做 YAML 转义{{DATE}}替换为日期正文中的{{TITLE}}、{{AUTHORS}}、{{ABSTRACT}}、{{DATE}}用_sanitize_text()处理写回文件将重组后的完整内容写入--output指定的文件。这意味着模板中其余章节的提示文案、表格骨架、div 组件与 CSS 会被原样保留作者只需替换提示内容即可。而 Reproducibility 中的 BibTeX 四重花括号{{{{TITLE}}}}经过替换后恰好输出合法的 BibTeX 双层花括号——这是模板与渲染逻辑协同设计的典型例证。6.3 四套模板的对比与选型从模板目录可以横向对比选型使用场景推荐模板理由在网页端分享、希望读者快速抓住要点modernDistill 风格语义组件 内嵌样式阅读体验最佳需要投递到传统会议/期刊格式standard经典分节编号与投稿模板的章节组织最接近需要展示大量公式与算法伪代码arxiv内置 LaTeX 公式块、Algorithm 环境和 IEEE 风格表格记录实验迭代过程而非正式论文ml-reportExecutive Summary 数据集/训练/部署全流程工程记录七、从 Markdown 到网页convert命令与发布链路生成 Markdown 论文后技能包支持将其转换为 HTML 以便在浏览器中分享uv run scripts/paper_manager.py convert \ --input paper.md \ --output paper.html \ --style modern--style modern对应本模板的现代排版风格。转换后的 HTML 会保留模板内嵌的 CSS 样式与 div 组件视觉效果配合渲染器实现动态目录、代码高亮与 LaTeX 公式显示。结合技能包的完整工作流一篇 Modern 风格论文的典型发布路径是详见 SKILL.md 中的集成示例# 1. 基于 modern 模板生成论文初稿 uv run scripts/paper_manager.py create \ --template modern \ --title Novel Fine-Tuning Approach \ --authors Jane Doe, John Smith \ --output paper.md # 2. 编辑 paper.md填入真实内容、替换资源链接 # 3. 提交 arXiv 并取得 arXiv ID外部流程 # 4. 在 Hugging Face 上索引论文 uv run scripts/paper_manager.py index --arxiv-id 2301.12345 # 5. 将论文关联到模型/数据集仓库 uv run scripts/paper_manager.py link \ --repo-id your-username/your-model \ --repo-type model \ --arxiv-id 2301.12345 # 6. 认领作者身份 uv run scripts/paper_manager.py claim \ --arxiv-id 2301.12345 \ --email your.emailedu其中link命令的底层逻辑见 paper_manager.py会下载目标仓库 README、解析或创建 YAML Frontmatter、在正文插入带边界标记!-- paper-manager:start --的论文引用区与 BibTeX 引用然后通过api.upload_file上传Hub 端会自动生成arxiv:PAPER_ID标签。这一系列操作让论文稿件与Hub 上的制品真正形成闭环。八、最佳实践与常见问题8.1 使用 Modern 模板的最佳实践综合模板设计意图与 examples/example_usage.md 中的建议关键洞察要前置在.key-insight框内用一句话写清核心贡献这是现代论文吸引读者停留的关键表格骨架直接复用Setup / Results / Ablation 的表格结构已经过设计只需替换为真实数据并保持 Baseline / Ours / SOTA 的对比结构资源链接务必补齐正文写完后再回头检查 header 区的 arXiv / PDF / Code / Demo 链接以及 Reproducibility 区的 Code / Models / Datasets / Demo 四项它们共同决定论文的可复现性统一模板使用同一研究组内的论文尽量统一采用modern模板保持对外呈现的一致性转换 HTML 分享将最终稿通过convert命令转为网页版便于在浏览器中快速阅读与传播。8.2 常见问题与排查生成的论文里仍是{{TITLE}}占位符说明渲染阶段替换失败请检查--title参数是否传入、paper_manager.py是否通过uv run正确加载内联依赖BibTeX 中花括号数量异常请勿手动修改模板中{{{{TITLE}}}}的四重花括号结构这是为渲染后输出合法 BibTeX 而设计的两级转义转换为 HTML 后组件样式丢失确认convert时--style参数与模板匹配modern 模板使用modern风格并检查 HTML 输出中是否保留了模板末尾的style块Link 操作报权限错误按 SKILL.md 的说明确认HF_TOKEN已设置且对目标仓库具备写权限创建文章本身为本地操作不受影响。九、总结Modern 模板是huggingface-paper-publisher技能包中面向网页阅读体验的现代论文排版方案。它通过 YAML Frontmatter 承载元数据、用语义化 div 组件abstract / key-insight / definition / experiment-details / insight / ablation-results / limitations / conclusion / reproducibility / appendix构建颜色即语义的视觉导航再以内嵌 CSS 统一全文排版而 paper_manager.py 的占位符替换机制Frontmatter 走 YAML 转义、正文走 Markdown 安全清洗保证了生成过程的健壮性create/convert两条命令则完成了从模板实例化到网页输出的完整链路。无论是撰写新的研究成果还是为已有工作补齐规范的论文页面这条模板 → Markdown → HTML → Hub 发布的路径都能显著降低排版成本、提升成果的可读与可复现性。延伸阅读模板目录 templates/ 中的另外三套模板standard.md、arxiv.md、ml-report.md技能完整说明见 SKILL.md命令速查见 quick_reference.md完整工作流示例见 example_usage.md。【免费下载链接】skillsGive your agents the power of the Hugging Face ecosystem项目地址: https://gitcode.com/GitHub_Trending/skills7/skills创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考