# Introduction

本项目用于[Advances and Open Problems in Federated Learning](https://arxiv.org/abs/1912.04977)文章的翻译，以及对翻译过程中涌现的**概念**和**命题**的解释。

可以通过访问【Gitbook】<https://xwzheng.gitbook.io/fl/> 阅读本项目内的内容

## 人员与分工

| 章节        | 翻译           | 校对 | 相关issue |
| --------- | ------------ | -- | ------- |
| 0. 摘要     | @lucifer2859 |    |         |
| 1. 引言     | @uceclz0     |    |         |
| 2. 核心假设   | @uceclz0     |    |         |
| 3. 性能和效率  | @LuoCJ       |    |         |
| 4. 数据隐私   | @girlfriend0 |    |         |
| 5. 防攻击和容错 | @mschen97    |    |         |
| 6. 公平性    | @XuanYang    |    |         |
| 7. 总结     | @XuanYang    |    |         |
| 8. 附录     | @XuanYang    |    |         |

## 目录结构

```
├── chapters
│   ├── 00-abstract.md                     # 摘要
│   ├── 01-introduction.md                 # 引言
│   ├── 02-core_assumptions.md             # 核心假设
│   ├── 03-efficiency_and_effectiveness.md # 性能和效率
│   ├── 04-privacy.md                      # 数据隐私
│   ├── 05-robustness.md                   # 防攻击和容错
│   ├── 06-fairness.md                     # 公平性
│   ├── 07-conclusion.md                   # 总结
│   ├── 08-appendix_a.md                   # 附录A
│   └── 09-appendix_b.md                   # 附录B-我们觉得一些额外重要的东西
├── docx
├── images
├── README.md
├── SUMMARY.md                             # Gitbook目录文件
└── templates
    └── docx-template.docx
```

## 格式要求

1. 图片放置在`images/chapter*/`目录下，图片的文件名不能有空格，插入图片时使用**相对路径**（如../images/chapter01/arch.png），而不是全路径
2. 文件格式使用markdown格式，推荐使用typora编辑器
3. 每章按一级、二级、三级目录进行组织，编排同原文

## 讨论

* 通过issue记录讨论的过程
* 对论文中提到的开放性问题要做重点标记和讨论

## Word生成

使用pandoc自动生成word，命令：

```bash
pandoc --highlight-style haddock  \
--reference-doc=./templates/docx-template.docx \
01.md  \
02.md  \
-o pandoc.docx
```

pandoc的安装：如果安装了anaconda，使用conda install pandoc后即可完成安装；否则参考<https://pandoc.org/installing.html>

## Gitbook

如果安装了gitbook，可以在项目目录中运行命令：

```
gitbook serve
```

然后可以在<http://localhost:4000> 上查看电子书


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://xwzheng.gitbook.io/fl/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.