Created by: lcy-seso

Goals

Goals of example configuration files are twofold:

1. Example configuration file is a kind of documentations to some extent, which shows how to use layers/pre-defined small networks in PaddlePaddle through examples. It is expected to be more lightweight than PaddleBook.

2. Backup of configuration files for newly developed layers/modules. Every time, if anyone adds a new layer into PaddlePaddle, or add a new pre-defined network into the paddle python package, he must have written a test configuration file. This test configuration file is also a good example to show how to use his new layer/network for other users.

Basic Requirements

1. Each example has its own directory, and (optional) some complicated examples may have sub-directory.
2. Each example should have at least two files
   • the model configuration, which includes the definition of the network topology, the optimization algorithm, the PaddlePaddle trainer, and how to read the data.
   • a README doc.
3. Each example should be tested without bugs.

About training/testing data

• always consider using dataset in paddle.dataset package first.
• If there is no appropriate dataset in paddle.dataset package, give a description of the format of the input data

Requirements on the README doc

• The REAMDE doc should have at least the following two sections:
  1. Brief introduction. The introduction should include: - what task does the configuration file for? - If the example does not provide data for training, it should provide descriptions about the format of the training data, and give an example to at least one training data.
  2. Explanation about the model architecture. A picture to show the model architecture, or refer to a certain reference. Chose a convenient way to make some explanations about the model architecture to let other know about why do you write the example and what the example wants to explain.
  3. [optional] How to run, but try to provide such an explanation as much as possible.