CI: add mdformat

Author: Borda

.actions/README.md

@@ -1,9 +1,11 @@
 scripts for generating notebooks
 
 **GHA here**
+
 - generate notebooks
 - flow to ban any added notebook in PR (fail if changes in .notebooks)
 
 **PL side**
+
 - git submodule with these examples
 - gha cron to update submodule head

.github/CONTRIBUTING.md

@@ -27,7 +27,7 @@ As a researcher, you can't have any part of your code going wrong. So, make thor
 
 PyTorch Lightning Tutorials is highly interoperable with PyTorch Lightning and PyTorch.
 
----
+______________________________________________________________________
 
 ## Contribution Types
 
@@ -38,25 +38,23 @@ A lot of good work has already been done in project mechanics (requirements/base
 ### Bug Fixes:
 
 1. If you find a bug please submit a GitHub issue. Make sure the title explains the issue.
+1. Try to fix it or recommend a solution.
+1. Submit a PR!
 
-2. Try to fix it or recommend a solution.
-
-3. Submit a PR!
-
-_**Note**, even if you do not find the solution, sending a PR with a test covering the issue is a valid contribution, and we can help you or finish it with you :]_
+_**Note**, even if you do not find the solution, sending a PR with a test covering the issue is a valid contribution, and we can help you or finish it with you :\]_
 
 ### New Models:
 
 PyTorch Lightning Tutorials shows several research models for ready usage. Following are general guidelines for adding new models.
 
 1. Workflows which are standard baselines
-2. Whose results are reproduced properly either by us or by authors.
-3. Do not reinvent the wheel, natively support torchvision, torchtext, torchaudio models.
-4. Use open source licensed models.
+1. Whose results are reproduced properly either by us or by authors.
+1. Do not reinvent the wheel, natively support torchvision, torchtext, torchaudio models.
+1. Use open source licensed models.
 
 Please raise an issue before adding a new tutorial. There are tons of models that keep coming. It is very difficult to support every peace.
 
----
+______________________________________________________________________
 
 ## Guidelines
 
@@ -74,10 +72,10 @@ In case you adding new dependencies, make sure that they are compatible with the
 
    All help is extremely welcome - reporting bugs, fixing documentation, etc. To solve some issues you can start with label [good first issue](https://github.com/PyTorchLightning/lightning-bolts/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or chose something close to your domain with label. Before you start to implement anything check that the issue description that it is clear and self-assign the task to you (if it is not possible, just comment that you take it, and we assign it to you...).
 
-2. **Is there a recommendation for branch names?**
+1. **Is there a recommendation for branch names?**
 
    We do not rely on the name convention so far you are working with your own fork. Anyway it would be nice to follow this convention `<type>/<issue-id>_<short-name>` where the types are: `bugfix`, `ipynb`, `docs`, ...
 
-3. **I have a model in other framework than PyTorch, how do I add it here?**
+1. **I have a model in other framework than PyTorch, how do I add it here?**
 
    Since PL Tutorials are aiming at Pytorch Lightning implementations we encourage staying with it.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,7 +4,6 @@ about: Create a report to help us improve
 title: ''
 labels: bug / fix, help wanted
 assignees: ''
-
 ---
 
 ## 🐛 Bug
@@ -16,9 +15,9 @@ assignees: ''
 Steps to reproduce the behavior:
 
 1. Go to '...'
-2. Run '....'
-3. Scroll down to '....'
-4. See error
+1. Run '....'
+1. Scroll down to '....'
+1. See error
 
 <!-- If you have a code sample, error messages, stack traces, please provide it here as well -->
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,10 +4,10 @@ about: Suggest an idea for this project
 title: ''
 labels: enhancement, help wanted
 assignees: ''
-
 ---
 
 ## 🚀 Feature
+
 <!-- A clear and concise description of the feature proposal -->
 
 ### Motivation

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,11 +5,14 @@
 - [ ] Did you write any new necessary tests?
 
 ## What does this PR do?
+
 Fixes # (issue).
 
 ## PR review
+
 Anyone in the community is free to review the PR once the tests have passed.
 If we didn't discuss your PR in Github issues there's a high chance it will not be merged.
 
 ## Did you have fun?
+
 Make sure you had fun coding 🙃

.pre-commit-config.yaml

@@ -39,12 +39,21 @@ repos:
     hooks:
       - id: yapf
 
-  - repo: https://github.com/PyCQA/flake8
-    rev: 3.9.2
-    hooks:
-      - id: flake8
-
   - repo: https://github.com/asottile/yesqa
     rev: v1.2.3
     hooks:
       - id: yesqa
+
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.7
+    hooks:
+      - id: mdformat
+        additional_dependencies:
+          - mdformat-gfm
+          - mdformat-black
+          - mdformat_frontmatter
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 3.9.2
+    hooks:
+      - id: flake8

README.md

@@ -7,41 +7,44 @@
 
 This is the Lightning Library - collection of Lightning related notebooks which are pulled back to the main repo as submodule and rendered inside the main documentations.
 The key features/highlights:
-* we keep the repo **light-weighted** - notebooks are stored in rich script format
-* all scripts/notebooks are tested to be **fully executable**
-* fully **reproducible** by saving runtime env. details
+
+- we keep the repo **light-weighted** - notebooks are stored in rich script format
+- all scripts/notebooks are tested to be **fully executable**
+- fully **reproducible** by saving runtime env. details
 
 For more details read our blogpost - [Best Practices for Publishing PyTorch Lightning Tutorial Notebooks](https://devblog.pytorchlightning.ai/publishing-lightning-tutorials-cbea3eaa4b2c)
 
 ## Adding/Editing notebooks
 
 This repo in main branch contain only python scripts with markdown extensions, and notebooks are generated in special publication branch, so no raw notebooks are accepted as PR.
 On the other hand we highly recommend creating a notebooks and convert it script with [jupytext](https://jupytext.readthedocs.io/en/latest/) as
+
 ```bash
 jupytext --set-formats ipynb,py:percent my-notebook.ipynb
 ```
 
 ### Contribution structure
 
 The addition has to formed as new folder
+
 - the folder name is used for the future notebooks
 - single python scripts with converted notebooks (name does not matter)
 - metadata named `.meta.yaml` including following info:
-    ```yaml
-    title: Sample notebooks
-    author: [User](contact)
-    created: YYYY-MM-DD
-    updated: YYYY-MM-DD
-    license: CC BY-SA
-    # multi-line
-    description: |
-      This notebook will walk you through ...
-    requirements:
-      - package  # with version if needed
-    # define supported - CPU|GPU|TPU
-    accelerator:
-      - CPU
-    ```
+  ```yaml
+  title: Sample notebooks
+  author: [User](contact)
+  created: YYYY-MM-DD
+  updated: YYYY-MM-DD
+  license: CC BY-SA
+  # multi-line
+  description: |
+    This notebook will walk you through ...
+  requirements:
+    - package  # with version if needed
+  # define supported - CPU|GPU|TPU
+  accelerator:
+    - CPU
+  ```
 
 ### Suggestions
 
@@ -56,6 +59,7 @@ The addition has to formed as new folder
 ## Meantime notes
 
 On the back side of publishing workflow you can find in principle these three steps
+
 ```bash
 # 1) convert script to notebooks
 jupytext --set-formats ipynb,py:percent notebook.py