Add pre-commit configs for repository

Signed-off-by: Anish Asthana <anishasthana1@gmail.com>

Author: anishasthana

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+      - id: black
+        language_version: python3.8

README.md

@@ -19,10 +19,14 @@ Can be installed via `pip`: `pip install codeflare-sdk`
 
 We recommend using Python 3.8 for development.
 Install development specific dependencies:
-  `$ pip install poetry pytest pytest-mock coverage black==22.3.0`
+  `$ pip install pre-commit poetry pytest pytest-mock coverage black==22.3.0`
 
 Additional dependencies can be found in `requirements.txt`: `$ pip install -r requirements.txt`
 
+### Pre-commit
+
+We use pre-commit to make sure the code is consistently formatted. To make sure that pre-commit is run every time you commit changes, simply run `pre-commit install`
+
 ### Testing
 
 - To run the unit tests, run `pytest -v tests/unit_test.py`

custom-nb-image/Dockerfile

@@ -20,7 +20,7 @@ COPY requirements.txt requirements.txt
 
 RUN pip install -r requirements.txt
 
-RUN pip uninstall pickle5 -y 
+RUN pip uninstall pickle5 -y
 
 # Install codeflare-sdk and other libraries
 RUN pip install codeflare-sdk==0.4.1 \

custom-nb-image/imagestream.yaml

@@ -20,8 +20,8 @@ metadata:
     opendatahub.io/notebook-image: 'true'
   annotations:
     opendatahub.io/notebook-image-name:
-      "Codeflare Notebook"
-    opendatahub.io/notebook-image-desc: "Custom Jupyter notebook image with codeflare SDK, Python 3.8, Ray 2.1.0 and PyTorch 1.12.1"
+      "CodeFlare Notebook"
+    opendatahub.io/notebook-image-desc: "Custom Jupyter notebook image with CodeFlare SDK, Python 3.8, Ray 2.1.0 and PyTorch 1.12.1"
 spec:
   lookupPolicy:
     local: true
@@ -32,8 +32,5 @@ spec:
       from:
         kind: DockerImage
         name: quay.io/project-codeflare/notebook:latest
-      name: "latest"
-      referencePolicy:
-        type: Source
       importPolicy:
         scheduled: true

demo-notebooks/batch-job/mnist.py

@@ -38,7 +38,6 @@
 
 class LitMNIST(LightningModule):
     def __init__(self, data_dir=PATH_DATASETS, hidden_size=64, learning_rate=2e-4):
-
         super().__init__()
 
         # Set our init args as class attributes
@@ -119,7 +118,6 @@ def prepare_data(self):
         MNIST(self.data_dir, train=False, download=True)
 
     def setup(self, stage=None):
-
         # Assign train/val datasets for use in dataloaders
         if stage == "fit" or stage is None:
             mnist_full = MNIST(self.data_dir, train=True, transform=self.transform)

demo-notebooks/batch-job/requirements.txt

@@ -1,4 +1,4 @@
 pytorch_lightning==1.5.10
 ray_lightning
 torchmetrics==0.9.1
-torchvision==0.12.0
+torchvision==0.12.0

docs/cluster/auth.html

@@ -49,7 +49,7 @@ <h1 class="title">Module <code>codeflare_sdk.cluster.auth</code></h1>
 The auth sub-module contains the definitions for the Authentication objects, which represent
 the methods by which a user can authenticate to their cluster(s). The abstract class, `Authentication`,
 contains two required methods `login()` and `logout()`. Users can use one of the existing concrete classes to
-authenticate to their cluster or add their own custom concrete classes here.  
+authenticate to their cluster or add their own custom concrete classes here.
 &#34;&#34;&#34;
 
 import abc
@@ -483,4 +483,4 @@ <h4><code><a title="codeflare_sdk.cluster.auth.TokenAuthentication" href="#codef
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

docs/cluster/cluster.html

@@ -1287,4 +1287,4 @@ <h4><code><a title="codeflare_sdk.cluster.cluster.Cluster" href="#codeflare_sdk.
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

docs/cluster/config.html

@@ -232,4 +232,4 @@ <h4><code><a title="codeflare_sdk.cluster.config.ClusterConfiguration" href="#co
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

docs/cluster/index.html

@@ -82,4 +82,4 @@ <h1>Index</h1>
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

docs/cluster/model.html

@@ -468,4 +468,4 @@ <h4><code><a title="codeflare_sdk.cluster.model.RayClusterStatus" href="#codefla
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

docs/index.html

@@ -67,4 +67,4 @@ <h1>Index</h1>
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

docs/job/index.html

@@ -62,4 +62,4 @@ <h1>Index</h1>
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

docs/job/jobs.html

@@ -566,4 +566,4 @@ <h4><code><a title="codeflare_sdk.job.jobs.JobDefinition" href="#codeflare_sdk.j
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

docs/utils/generate_yaml.html

@@ -882,4 +882,4 @@ <h1>Index</h1>
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

docs/utils/index.html

@@ -69,4 +69,4 @@ <h1>Index</h1>
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

docs/utils/pretty_print.html

@@ -450,4 +450,4 @@ <h1>Index</h1>
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

src/codeflare_sdk.egg-info/SOURCES.txt

@@ -15,4 +15,4 @@ src/codeflare_sdk/job/__init__.py
 src/codeflare_sdk/job/jobs.py
 src/codeflare_sdk/utils/__init__.py
 src/codeflare_sdk/utils/generate_yaml.py
-src/codeflare_sdk/utils/pretty_print.py
+src/codeflare_sdk/utils/pretty_print.py

src/codeflare_sdk.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

src/codeflare_sdk/cluster/auth.py

@@ -16,7 +16,7 @@
 The auth sub-module contains the definitions for the Authentication objects, which represent
 the methods by which a user can authenticate to their cluster(s). The abstract class, `Authentication`,
 contains two required methods `login()` and `logout()`. Users can use one of the existing concrete classes to
-authenticate to their cluster or add their own custom concrete classes here.  
+authenticate to their cluster or add their own custom concrete classes here.
 """
 
 import abc

src/codeflare_sdk/templates/base-template.yaml

@@ -153,4 +153,4 @@ spec:
                       memory: "512Mi"
                     requests:
                       cpu: "500m"
-                      memory: "256Mi"
+                      memory: "256Mi"

src/codeflare_sdk/templates/new-template.yaml

@@ -189,7 +189,7 @@ spec:
                   - name: MY_POD_IP
                     valueFrom:
                       fieldRef:
-                        fieldPath: status.podIP 
+                        fieldPath: status.podIP
                   # environment variables to set in the container.Optional.
                   # Refer to https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/
                   lifecycle:
@@ -220,4 +220,4 @@ spec:
             kind: Service
             name: deployment-name-head-svc
           port:
-            targetPort: dashboard 
+            targetPort: dashboard

tests/unit_test.py

@@ -1920,7 +1920,6 @@ def test_DDPJob_cancel(mocker):
 
 
 def parse_j(cmd):
-
     pattern = r"--nnodes\s+\d+\s+--nproc_per_node\s+\d+"
     match = re.search(pattern, cmd)
     if match: