docs(README): 更新README中的Extra Chapter说明和PR规范
更新README.md中的Extra Chapter部分,添加了日期标记并格式化说明文本。同时新增Extra-Chapter/Readme.md文件,详细说明Extra Chapter的目的、内容类型和PR贡献规范。 新增Extra-Chapter/Readme.md文件,包含: - Extra Chapter的设立目的和内容类型 - PR贡献规范(目录结构、文件命名、内容质量要求) - PR commit message模板
This commit is contained in:
120
Extra-Chapter/Readme.md
Normal file
120
Extra-Chapter/Readme.md
Normal file
@@ -0,0 +1,120 @@
|
||||
<div align="center">
|
||||
<h2>🚀 Happy-LLM 扩展内容</h2>
|
||||
<p><em>社区驱动的大语言模型学习资源</em></p>
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 📖 为什么会有 Extra Chapter?
|
||||
|
||||
  在 Happy-LLM 主教程的基础上,我们发现社区中有许多优秀的学习者和实践者,他们在学习和使用大语言模型的过程中积累了宝贵的经验、独到的见解和实用的技巧。这些内容虽然不属于主教程的核心知识体系,但对于深入理解和应用大语言模型具有重要价值。
|
||||
|
||||
**Extra Chapter 的设立目的:**
|
||||
|
||||
- 🌟 **汇聚智慧**:收集社区成员的优秀学习笔记、实践经验和技术博客
|
||||
- 🔄 **持续更新**:保持内容的时效性,跟上大语言模型领域的快速发展
|
||||
- 🤝 **促进交流**:为社区成员提供分享和交流的平台
|
||||
- 📚 **补充完善**:对主教程内容进行有益的补充和扩展
|
||||
- 💡 **启发思考**:通过不同视角和实践案例,启发读者的深度思考
|
||||
|
||||
**Extra Chapter 包含的内容类型:**
|
||||
|
||||
- 📝 **学习笔记**:深度学习心得和知识总结
|
||||
- 🛠️ **实践案例**:真实项目中的应用经验
|
||||
- 🔬 **技术探索**:前沿技术的研究和实验
|
||||
- 💭 **思考感悟**:对大语言模型发展的独特见解
|
||||
- 🎯 **专题研究**:特定领域或问题的深入分析
|
||||
|
||||
---
|
||||
|
||||
## 📋 PR 贡献规范
|
||||
|
||||
  我们热烈欢迎社区成员为 Extra Chapter 贡献优质内容!为了保证内容质量和项目的整体性,请遵循以下规范:
|
||||
|
||||
### 🗂️ 目录结构规范
|
||||
|
||||
每个贡献的内容应按照以下目录结构组织:
|
||||
|
||||
```
|
||||
Extra-Chapter/
|
||||
├── your-topic-name/ # 你的主题文件夹
|
||||
│ ├── readme.md # 主要内容文件(必需)
|
||||
│ ├── images/ # 图片资源文件夹(可选)
|
||||
│ │ ├── figure1.png
|
||||
│ │ └── figure2.jpg
|
||||
│ ├── code/ # 代码文件夹(可选)
|
||||
│ │ ├── example.py
|
||||
│ │ └── requirements.txt
|
||||
│ ├── data/ # 数据文件夹(可选)
|
||||
│ │ └── sample_data.json
|
||||
│ └── notebook.ipynb # Jupyter Notebook(如涉及代码必选)
|
||||
└── Readme.md # 本文件
|
||||
```
|
||||
|
||||
### 📝 文件命名规范
|
||||
|
||||
1. **主题文件夹命名**:
|
||||
- 使用小写字母和连字符
|
||||
- 名称要简洁明了,能够概括主题内容
|
||||
- 例如:`why-fine-tune-small-large-language-models`、`rag-optimization-techniques`
|
||||
|
||||
2. **主要内容文件**:
|
||||
- 必须命名为 `readme.md`
|
||||
- 使用 Markdown 格式编写
|
||||
|
||||
3. **图片文件**:
|
||||
- 统一放在 `images/` 文件夹下
|
||||
- 使用描述性的文件名
|
||||
- 支持格式:`.png`、`.jpg`、`.jpeg`、`.gif`、`.svg`
|
||||
|
||||
4. **代码文件**:
|
||||
- 如涉及代码,请尽量提供可直接运行的 Jupyter Notebook 文件
|
||||
- 统一放在 `code/` 文件夹下
|
||||
- 使用标准的文件扩展名
|
||||
- 如有依赖,请提供 `requirements.txt`
|
||||
- 如有 Jupyter Notebook 文件,请放在主文件夹下
|
||||
|
||||
### ✍️ 内容质量要求
|
||||
|
||||
1. **原创性**:
|
||||
- 内容必须是原创或经过授权的
|
||||
- 如引用他人内容,请注明出处
|
||||
|
||||
2. **技术准确性**:
|
||||
- 确保技术内容的准确性
|
||||
- 代码示例应能正常运行
|
||||
- 提供必要的环境说明
|
||||
|
||||
3. **结构清晰**:
|
||||
- 使用清晰的标题层次
|
||||
- 合理使用列表、表格等格式
|
||||
- 重要内容使用适当的强调
|
||||
|
||||
4. **语言规范**:
|
||||
- 使用规范的中文表达
|
||||
- 技术术语使用准确
|
||||
- 避免错别字和语法错误
|
||||
|
||||
### PR commit messgae 内容
|
||||
|
||||
请在 PR commit message 中 包含以下内容:
|
||||
|
||||
- 新增的主题文件夹名称
|
||||
- 贡献内容的概述
|
||||
- 贡献内容的详细描述
|
||||
- 你的 Github 个人主页链接,及你的个人介绍
|
||||
- 个人 title 及工作经历 or 学校 or 研究方向
|
||||
|
||||
如以下所示:
|
||||
|
||||
```
|
||||
Extra Chapter: 你的主题名称
|
||||
|
||||
详细描述你的贡献内容,包括新增的主题文件夹、文件内容和目录结构。
|
||||
|
||||
- 新增的主题文件夹名称:your-topic-name
|
||||
- 贡献内容的概述:详细介绍你的贡献内容
|
||||
- 贡献内容的详细描述:详细描述你的贡献内容,包括新增的主题文件夹、文件内容和目录结构。
|
||||
- 你的 Github 个人主页链接及个人介绍:[你的个人主页链接](https://example.com),介绍你的研究方向、技术专长等。
|
||||
- 个人 title 及工作经历 or 学校 or 研究方向:内容贡献者-xxxx学校,研究方向为自然语言处理。
|
||||
```
|
||||
@@ -61,10 +61,10 @@
|
||||
|
||||
### Extar Chapter LLM Blog
|
||||
|
||||
- [大模型都这么厉害了,微调0.6B的小模型有什么意义?](./Extra-Chapter/why-fine-tune-small-large-language-models/readme.md) @[不要葱姜蒜](https://github.com/KMnO4-zx)
|
||||
- [大模型都这么厉害了,微调0.6B的小模型有什么意义?](./Extra-Chapter/why-fine-tune-small-large-language-models/readme.md) @[不要葱姜蒜](https://github.com/KMnO4-zx) 2025-7-11
|
||||
|
||||
|
||||
> 如果大家在学习 Happy-LLM 项目或 LLM 相关知识中有自己独到的见解、认知、实践,欢迎大家 PR 在 [Extra Chapter LLM Blog](./Extra-Chapter/) 中。请遵守 Extra Chapter LLM Blog 的 PR 规范,我们会视 PR 内容的质量和价值来决定是否合并或补充到 Happy-LLM 正文中来。
|
||||
>   ***如果大家在学习 Happy-LLM 项目或 LLM 相关知识中有自己独到的见解、认知、实践,欢迎大家 PR 在 [Extra Chapter LLM Blog](./Extra-Chapter/) 中。请遵守 Extra Chapter LLM Blog 的 [PR 规范](./Extra-Chapter/Readme.md),我们会视 PR 内容的质量和价值来决定是否合并或补充到 Happy-LLM 正文中来。***
|
||||
|
||||
### 模型下载
|
||||
|
||||
|
||||
Reference in New Issue
Block a user