Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update developer guide for sphinx docs #246

Merged
merged 1 commit into from
Mar 12, 2024
Merged

Update developer guide for sphinx docs #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# How-to Guide for Developers

* [How-to Guide for Developers](#how-to-guide-for-developers)
* [Coding Style](#coding-style)
* [Build your own OPs](#build-your-own-ops)
* [(Optional) Make your OP fusible](#optional-make-your-op-fusible)
* [Build your own configs](#build-your-own-configs)
* [Fruitful config sources & Type hints](#fruitful-config-sources--type-hints)
* [Hierarchical configs and helps](#hierarchical-configs-and-helps)
- [How-to Guide for Developers](#how-to-guide-for-developers)
- [Coding Style](#coding-style)
- [Build your own OPs](#build-your-own-ops)
- [(Optional) Make your OP fusible](#optional-make-your-op-fusible)
- [Build your own configs](#build-your-own-configs)
- [Fruitful config sources \& Type hints](#fruitful-config-sources--type-hints)
- [Hierarchical configs and helps](#hierarchical-configs-and-helps)

## Coding Style

Expand Down Expand Up @@ -281,6 +281,8 @@ the corresponding documents, including the following docs:
3. `docs/Operators_ZH.md`: this doc is the Chinese version of the doc in 6.ii, so we need to update the Chinese content at
the same positions.

4. `docs/sphinx_doc/source/data_juicer.ops.{filter | mapper | deduplicator | selector}.rst`: this doc is the index of API reference. When the operator file name is modified or an operator file is added or deleted, the corresponding entries in the file need to be updated accordingly.

### (Optional) Make your OP fusible

- If the calculation process of some intermediate variables in the new OP is reused in other existing OPs, this new OP can be
Expand Down
16 changes: 9 additions & 7 deletions docs/DeveloperGuide_ZH.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# 开发者指南

* [开发者指南](#开发者指南)
* [编码规范](#编码规范)
* [构建自己的算子](#构建自己的算子)
* [（可选）使新算子可以进行算子融合](#可选使新算子可以进行算子融合)
* [构建自己的配置](#构建自己的配置)
* [丰富的配置源和类型提示](#丰富的配置源和类型提示)
* [层次化的配置和帮助](#层次化的配置和帮助)
- [开发者指南](#开发者指南)
- [编码规范](#编码规范)
- [构建自己的算子](#构建自己的算子)
- [（可选）使新算子可以进行算子融合](#可选使新算子可以进行算子融合)
- [构建自己的配置](#构建自己的配置)
- [丰富的配置源和类型提示](#丰富的配置源和类型提示)
- [层次化的配置和帮助](#层次化的配置和帮助)

## 编码规范

Expand Down Expand Up @@ -272,6 +272,8 @@ if __name__ == '__main__':

3. `docs/Operators_ZH.md`：该文档为6.ii中`docs/Operators.md`文档的中文版，需要更新相同位置处的中文内容。

4. `docs/sphinx_doc/source/data_juicer.ops.{filter | mapper | deduplicator | selector}.rst`: 该文档为 API 文档索引，在修改算子文件名称或增删算子文件的情况下需要对应更新文件中对应的条目。

### （可选）使新算子可以进行算子融合

- 如果我们的新算子中的部分中间变量的计算过程与已有的算子重复，那么可以将其添加到可融合算子中，以在数据处理时利用算子融合进行加速。（如`word_num_filter`与`word_repetition_filter`都需要对输入文本进行分词）
Expand Down
Loading