From 9ea71e80e019f75c6e89d334cd7bb33330cf3453 Mon Sep 17 00:00:00 2001 From: Lukas Masuch Date: Wed, 7 Aug 2019 11:20:38 +0200 Subject: [PATCH] Initial project structure --- .github/ISSUE_TEMPLATE.md | 15 ++++ .github/ISSUE_TEMPLATE/01_bug-report.md | 49 ++++++++++++ .github/ISSUE_TEMPLATE/02_feature-request.md | 32 ++++++++ .github/ISSUE_TEMPLATE/03_documentation.md | 16 ++++ .../ISSUE_TEMPLATE/04_installation-problem.md | 24 ++++++ .github/ISSUE_TEMPLATE/05_anything-else.md | 24 ++++++ .github/PULL_REQUEST_TEMPLATE.md | 23 ++++++ .github/SUPPORT.md | 3 + .gitignore | 52 +++++++++++++ CHANGELOG.md | 1 + CODE_OF_CONDUCT.md | 76 +++++++++++++++++++ CONTRIBUTING.md | 1 + README.md | 68 ++++++++++++++++- 13 files changed, 382 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/01_bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/02_feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/03_documentation.md create mode 100644 .github/ISSUE_TEMPLATE/04_installation-problem.md create mode 100644 .github/ISSUE_TEMPLATE/05_anything-else.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/SUPPORT.md create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..803359b --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,15 @@ + + +**Describe the issue:** + + + +**Technical details:** + +- Library version : +- Python version: +- SSH version : diff --git a/.github/ISSUE_TEMPLATE/01_bug-report.md b/.github/ISSUE_TEMPLATE/01_bug-report.md new file mode 100644 index 0000000..329f317 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_bug-report.md @@ -0,0 +1,49 @@ +--- +name: "\U0001F6A8 Bug report" +about: Did you come across a bug or unexpected behaviour differing from the docs? +title: '' +labels: bug +assignees: '' + +--- + + + +**Describe the bug:** + + + +**Expected behaviour:** + + + +**Steps to reproduce the issue:** + + + + + +**Technical details:** + +- Library version : +- Python version: +- SSH version : + +**Possible Fix:** + + + +**Additional context:** + + diff --git a/.github/ISSUE_TEMPLATE/02_feature-request.md b/.github/ISSUE_TEMPLATE/02_feature-request.md new file mode 100644 index 0000000..6741077 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_feature-request.md @@ -0,0 +1,32 @@ +--- +name: "\U0001F381 Feature request" +about: Do you have an idea for an improvement or a new feature? +title: '' +labels: feature-request +assignees: '' + +--- + + + +**Feature description:** + + + +**Problem and motivation:** + + + +**Is this something you're interested in working on?** + + diff --git a/.github/ISSUE_TEMPLATE/03_documentation.md b/.github/ISSUE_TEMPLATE/03_documentation.md new file mode 100644 index 0000000..e529ff1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03_documentation.md @@ -0,0 +1,16 @@ +--- +name: "\U0001F4DA Documentation" +about: Is there a mistake in the docs, is anything unclear or do you have a suggestion? +title: '' +labels: enhancement, docs +assignees: '' + +--- + +**Describe your request:** + + + +**Which page or section is this issue related to?** + + diff --git a/.github/ISSUE_TEMPLATE/04_installation-problem.md b/.github/ISSUE_TEMPLATE/04_installation-problem.md new file mode 100644 index 0000000..32ecb22 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04_installation-problem.md @@ -0,0 +1,24 @@ +--- +name: "\U0001F433 Installation Problem" +about: Do you have problems with installation, and none of the suggestions in the docs and other issues helped? +title: '' +labels: '' +assignees: '' + +--- + + + +**Describe the issue:** + + + +**Technical details:** + +- Library version : +- Python version: +- SSH version : \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/05_anything-else.md b/.github/ISSUE_TEMPLATE/05_anything-else.md new file mode 100644 index 0000000..a93a74e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/05_anything-else.md @@ -0,0 +1,24 @@ +--- +name: "\U0001F4AC Anything else?" +about: For general usage questions, please consider posting on Stack Overflow or Gitter instead. +title: '' +labels: '' +assignees: '' + +--- + + + +**Describe the issue:** + + + +**Technical details:** + +- Library version : +- Python version: +- SSH version : \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..bad3929 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,23 @@ + + +**What kind of change does this PR introduce?** + + +- [ ] Bugfix +- [ ] New Feature +- [ ] Feature Improvment +- [ ] Refactoring +- [ ] Documentation +- [ ] Other, please describe: + +**Description:** + + +**Checklist:** + + +- [ ] I have read the [CONTRIBUTING](https://github.com/ml-tooling/lazycluster/blob/master/CONTRIBUTING.md) document. +- [ ] My changes don't require a change to the documentation, or if they do, I've added all required information. \ No newline at end of file diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..6f4ce99 --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,3 @@ +## Support + +Please refer to our [support](https://github.com/ml-tooling/lazycluster#support) and [contribution](https://github.com/ml-tooling/lazycluster#contribution) sections on our main README for more information. \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fba41d0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,52 @@ +# Platform Artifacts +environment/ +logs/ +*.log + +# IntelliJ +target/ +.idea/ +*.iml + +# Sublime +*.sublime-workspace + +# Eclipse +.settings + +# VS Code +.vscode +.project +.classpath + +# Java +*.class +target/ + +# C +*.so + +# Python +*.pyc +*.egg-info +__pycache__ +.ipynb_checkpoints +.Python +dist/ +build/ +.python-version +.installed.cfg +*.egg + +# Byte-compiled / optimized / DLL files +*.pyc +__pycache__/ +*.py[cod] +*$py.class + +# Other Artifacts +hs_err_pid* +*.log +*.swp +temp/* +.DS_Store \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2fd9f95 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1 @@ +TBD \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0616741 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at mltooling.team@gmail.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2fd9f95 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +TBD \ No newline at end of file diff --git a/README.md b/README.md index 9f06728..8d2153f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,66 @@ -# lazycluster -πŸŽ›Distributed Machine Learning made Simple. +

+ lazycluster +
+

+ +

+ Distributed machine learning made simple. +

+ +

+ + + +

+ +

+ Getting Started β€’ + Highlights β€’ + Features β€’ + API Docs β€’ + Support β€’ + Report a Bug β€’ + Contribution +

+ +_WIP: Short Description (max. 4 lines)_ + +## Highlights + +_WIP: Hightlights_ + +## Getting Started + +### Installation + +_WIP: pip installation and mention prerequisites if there are some_ + +### Usage Example + +_WIP: Add usage example that can be easily copy-pasted to try out the library_ + +## Support + +The lazycluster project is maintained by [Jan Kalkan](https://www.linkedin.com/in/jan-kalkan-b5390284/). Please understand that we won't be able to provide individual support via email. We also believe that help is much more +valuable if it's shared publicly so that more people can benefit from it. + +| Type | Channel | +| ------------------------ | ------------------------------------------------------ | +| 🚨 **Bug Reports** | | +| 🎁 **Feature Requests** | | +| πŸ‘©β€πŸ’» **Usage Questions** | | +| πŸ—― **General Discussion** | + +## Features + +_WIP: Describe with high level features code examples. E.g. DaskCluster, Chunked Preprocessing, Runtime Group Port Handling..._ + +## Contribution + +- Pull requests are encouraged and always welcome. Read [`CONTRIBUTING.md`](https://github.com/ml-tooling/lazycluster/tree/master/CONTRIBUTING.md) and check out [help-wanted](https://github.com/ml-tooling/lazycluster/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3A"help+wanted"+sort%3Areactions-%2B1-desc+) issues. +- Submit github issues for any [feature enhancements](https://github.com/ml-tooling/lazycluster/issues/new?assignees=&labels=feature-request&template=02_feature-request.md&title=), [bugs](https://github.com/ml-tooling/lazycluster/issues/new?assignees=&labels=bug&template=01_bug-report.md&title=), or [documentation](https://github.com/ml-tooling/lazycluster/issues/new?assignees=&labels=enhancement%2C+docs&template=03_documentation.md&title=) problems. +- By participating in this project you agree to abide by its [Code of Conduct](https://github.com/ml-tooling/lazycluster/tree/master/CODE_OF_CONDUCT.md). + +--- + +Licensed **Apache 2.0**. Created and maintained with ❀️ by developers from SAP in Berlin. \ No newline at end of file