[Feature Request] refactor the project

[wj-Mcat]

Description

In the suggested structuring python project, there are some conventional structures & files & naming-style to make the project more readable and scalable. And what's more, there are some github Action tools to run CI to lint & test code, run CD to publish the project.

Thought

I also maintain the project: python-wechaty and paddle-prompt. So I'm familiar with the related opensource toolkits in python project. I can create an another pr to complete this If you agree with it ? How do you think about it ? @tata1661

[tata1661]

@wj-Mcat It is nice to use CI tools with your help^^. Thanks!
Just be careful if you consider different naming style which affects existing users. You can create a PR first. Then, we can discuss it.

[wj-Mcat]

After taking a great discussion with @tata1661 , all us agree that there are some improvement to be done to make project easier to use, easier to read, easier to do experiments on their own datasets. So, we have a development plan of about a month. Here are improvements:

• Open Source Toolkit
  • CI workflow which will test code with lint tool, eg: pylint, mypy and so on ...
  • CD workflow which will automaticlly deploy the project to pypi server ...
• make project easier to install with just one command: pip install paddlefsl
• create docs website with mkdocs to make project easier to read : paddlefsl.readthedocs.io
• make a more attractive README.md for developer
• move examples to the aistudio so that developer can fork & run. so simple ....

And what's more, we will create latest few-shot-learning models from baidu-search, please keep eyes on this repo, we make it more great. 👹 👹 👹

[wj-Mcat]

I'll create some prs which align with the above items to do accomplete the goals step by step on the dev branch. We are welcome developers to contribute your own great ideas into this project.