re-structure the project with standard template

[wj-Mcat]

Description

try to finish the plan: #24

I don't modify the content of source code but the project structure which is added into some more useful tools to make it more extensive, eg:

• Makefile: workflow scripts
• requirements-dev.txt: dependency packages only used in developemtn
• pyproject.toml: store the project metadata which can be used in many opensource toos, eg: pytest, mypy, pylint.

Another work in this pr: move the paddlefsl to the root dir to make it more clear about the source code.

To get the details, you can read the project tree structure in files of pr.

[wj-Mcat]

You can read the project structure from here:

[wj-Mcat]

VERSION file will mark a dev tag to the published package.

[tata1661]

@wj-Mcat Thanks for your contribution!
This repo serves as a tool for users to quickly find resources of FSL, which is not limited to Paddle codes.
Thus, we would rather keep PaddleFSL as a subdirectory in FSL-Mate.

Except that, the other changes are nice. However, this branch has conflict with the current FSL-Mate. Please double check with your PR.

[wj-Mcat]

I understand this repo acts as a tool for developers who use paddle to creat model. Below are my points, if you also thinks we should keep the current structure, I will convert it back.

1. I think FSL is at the same level with PaddleNLP, PaddleOCR, PaddleClas and so on. All of these tools provide out of box modules to be used in any other project. After checking the structure of these project, they follow the python-style to structure the project. So, from this side, I suggest we can use this same structure style.

2. If the developer read the README and docs (waiting to be added & improved), they will get the tools in FSL-Mate. Althogh we suggest that the beginner should read the source code, docs can be more friendly to them. If the developer is family with python, subdirectory is not the problem for them and python-style structure will make them more comfort.

This is my consideration, I'm looking forward your next reply. 🤡 🤡 🤡

[tata1661]

I understand this repo acts as a tool for developers who use paddle to creat model.

@wj-Mcat This is not the aim of this repo.

As said before, ``this repo serves as a tool for users to quickly find resources of FSL, which is not limited to Paddle codes".
We care about both people from academics and industry, wishing to contribute to the advances of FSL. This is not limited to offering codes.
We include paper list, and paddle codes so far. We may also provide codes in other frameworks or some tutorials on FSL in the future.

[wj-Mcat]

OK, I will convert it back. 😆 please wait for my new commits.

[wj-Mcat]

I have converted it to PaddleFSL subdirectory structure. please review it when you have time. @tata1661

[wj-Mcat]

不好意思，我这周在准备学校毕业答辩的相关事情，等周五过后我会继续推进这个PR。

[wj-Mcat]

I have set the CICD workflow script for project, which contains:

• make unittest with pytest, all of you should do is: make test
• make code linting with mypy, pylint, flake8, all of you should do is: make test
• use requirements.txt to store the production packages, eg: paddlenlp, numpy, tqdm and so on. use requirements-dev.txt to store the development packages, eg: pytest, pylint, mypy and so on.
• use pyproject.toml file to store the configurations of different tools, eg: pytest, mypy.
• automaticlly deploy the package to the pypi server, but you should set secret token, named as PYPI_TOKEN, in project setting. feature should be tested.

[tata1661]

@wj-Mcat Thanks! I am also busy working on several DDLs. I will check your commits later this week.

[wj-Mcat]

Closed according to #24, I'll work on the dev branch.