From 4125374814deccc37971801fea5c037412669bdc Mon Sep 17 00:00:00 2001 From: =?utf8?q?=EC=B5=9C=EC=84=B1=EC=A7=84/=EB=8F=99=EC=9E=91=EC=A0=9C?= =?utf8?q?=EC=96=B4Lab=28SR=29/Principal=20Engineer/=EC=82=BC=EC=84=B1?= =?utf8?q?=EC=A0=84=EC=9E=90?= Date: Wed, 18 Jul 2018 18:02:13 +0900 Subject: [PATCH] Document for an incubating project (#666) This commit introduces a document for how to start an incubating project. Signed-off-by: lotieye.choi --- doc/project_guide.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 doc/project_guide.md diff --git a/doc/project_guide.md b/doc/project_guide.md new file mode 100644 index 0000000..069f3b7 --- /dev/null +++ b/doc/project_guide.md @@ -0,0 +1,24 @@ +### How to create your own project +_nncc_ aims to make it easy to develop optimized, retargetable NN compilers. Anyone or team interested in _nncc_ can create a new incubating project. + +#### Subject +Subject is related to NN(Neural Network) complier. Some examples are below, but not limited: +- NN IR(Intermediate Representation) +- Extended frontend and backend +- High-performance (model optimization, memory optimization, scheduling, etc.) +- Tools (verification, benchmark, visualization, etc.) +- Tutorial, testbed + +#### How to propose +There is no formal proposal process. Anyone can submit an issue or a PR as a starting point of a proposal. It would be helpful that the submissions have documents or descriptions containing the followings to share your idea and concept and attract new contibutors to your project (not mandatory): +- Overview, goal or architecture description to explain your project +- How-to guide including building and running your programs + +#### Directory to use +- A directory under `contrib/`, which starts with your project name. + +#### Requirement +- A project should follow the formal review process that _nncc_ is currently using [[(How to create a Pull Request (in contribution guide)](https://github.sec.samsung.net/STAR/nncc/blob/master/doc/contribution_guide.md#how-to-create-a-pull-request)]. + +#### How to contribute +Anyone who wants to contribute can create and submit PRs and issues following [nncc contribution_guide](https://github.sec.samsung.net/STAR/nncc/blob/master/doc/contribution_guide.md). _nncc_ always welcomes your contribution. -- 2.7.4