Merge pull request #13 from mlops-club/feature/onboarding-instructions

Added onboarding instructions

.gitignore

@@ -6,11 +6,6 @@ node_modules
 *.vsix
 *ipynb*
 *venv*
-dev-utils/volumes/opt/clearml/agent
-dev-utils/volumes/opt/clearml/data
-dev-utils/volumes/opt/clearml/logs
-dev-utils/volumes/opt/clearml/config/generated_credentials.env
-dev-utils/volumes/opt/clearml/config/clearml.conf
-dev-utils/volumes/usr
 *.log
-coverage
+coverage
+__pycache__/

.vscode/extensions.json

@@ -6,6 +6,8 @@
     "amodio.tsl-problem-matcher",
     "ms-python.python",
     "ms-vscode-remote.remote-ssh",
-    "GitHub.copilot"
+    "GitHub.copilot",
+    "redhat.vscode-yaml",
+    "ms-vsliveshare.vsliveshare",
   ]
 }

.vscode/launch.json

@@ -12,7 +12,7 @@
       "args": [
         "--extensionDevelopmentPath=${workspaceFolder}",
         // automatically open the dev VS Code in the clearml-playground-workspace folder
-        "${workspaceFolder}/dev-utils/clearml-playground-workspace"
+        "${workspaceFolder}/bentoml-playground-workspace"
       ],
       "outFiles": ["${workspaceFolder}/dist/**/*.js"],
       "preLaunchTask": "${defaultBuildTask}"

.vscode/settings.json

@@ -9,5 +9,15 @@
     "dist": true // set this to false to include "dist" folder in search results
   },
   // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
-  "typescript.tsc.autoDetect": "off"
+  "typescript.tsc.autoDetect": "off",
+  "json.schemas": [
+    {
+      "fileMatch": ["**/*bentofile.json"],
+      "url": "./src/resources/yamlSchemas/bentofileSchema.json"
+    }
+  ],
+  "json.validate.enable": true,
+  "yaml.schemas": {
+    "./src/resources/yamlSchemas/bentofileSchema.json": "**/*bentofile.yaml"
+  }
 }

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-All notable changes to the "clearml-session-manager" extension will be documented in this file.
+All notable changes to the `vscode-bentoml` extension will be documented in this file.
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 

bentoml-playground-workspace/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "bentoml.bentomlHomeDir": "~/bentoml"
+}

dev-utils/clearml-playground-workspace/README.md → bentoml-playground-workspace/README.md

@@ -1,7 +1,7 @@
-# `clearml-playground-workspace`
+# `bentoml-playground-workspace`
 
 If you press `F5` to debug this extension, it will open up a development VS Code window
 with
 
-- the version of `clearml-session-manager` in this repo, activated
+- the version of the `vscode-bentoml` extension in this repo, activated
 - this folder as the workspace

bentoml-playground-workspace/bentofile.yaml

@@ -0,0 +1,3 @@
+docker:
+  python_version: 3.10
+  docker_base_image: "python:3.11-slim"

bentoml-playground-workspace/linear_regression/README.md

@@ -0,0 +1,37 @@
+# BentoML Sklearn Example: Linear Regression
+
+0. Install dependencies:
+
+```bash
+pip install -r ./requirements.txt
+```
+
+1. Train a linear regression model
+
+```bash
+python ./train.py
+```
+
+2. Run the service:
+
+```bash
+bentoml serve service.py:svc
+```
+
+3. Send test request
+
+```
+curl -X POST -H "content-type: application/json" --data "[[5, 3]]" http://127.0.0.1:3000/predict
+```
+
+4. Build Bento
+
+```
+bentoml build
+```
+
+5. Build docker image
+
+```
+bentoml containerize linear_regression:latest
+```

bentoml-playground-workspace/linear_regression/bentofile.yaml

@@ -0,0 +1,5 @@
+service: "service.py:svc"
+include:
+  - "service.py"
+python:
+  requirements_txt: "./requirements.txt"

bentoml-playground-workspace/linear_regression/requirements.txt

@@ -0,0 +1,2 @@
+bentoml>=1.0.0
+scikit-learn

bentoml-playground-workspace/linear_regression/service.py

@@ -0,0 +1,13 @@
+import bentoml
+from bentoml.io import NumpyNdarray
+
+reg_runner = bentoml.sklearn.get("linear_reg:latest").to_runner()
+
+svc = bentoml.Service("linear_regression", runners=[reg_runner])
+
+input_spec = NumpyNdarray(dtype="int", shape=(-1, 2))
+
+
+@svc.api(input=input_spec, output=NumpyNdarray())
+async def predict(input_arr):
+    return await reg_runner.predict.async_run(input_arr)

bentoml-playground-workspace/linear_regression/train.py

@@ -0,0 +1,16 @@
+from sklearn import linear_model
+
+import bentoml
+
+if __name__ == "__main__":
+    reg = linear_model.LinearRegression()
+    reg.fit([[0, 0], [1, 1], [2, 2]], [0, 1, 2])
+
+    print("coef: ", reg.coef_)
+    bento_model = bentoml.sklearn.save_model("linear_reg", reg)
+    print(f"Model saved: {bento_model}")
+
+    # Test running inference with BentoML runner
+    test_runner = bentoml.sklearn.get("linear_reg:latest").to_runner()
+    test_runner.init_local()
+    assert test_runner.predict.run([[1, 1]]) == reg.predict([[1, 1]])