messing around with readme

README.md

@@ -0,0 +1,30 @@
+# Data Mining from scratch backend
+
+Currently living [here](https://data-mining-from-scratch-backend.onrender.com/)
+
+### Example Useage
+
+```python
+import requests
+import json
+
+request_params = {
+    "algorithm": "neural-network",
+    "arguments": {
+        "epochs": 100,
+        "activation_func": "relu",
+        "hidden_size": "8",
+        "learning_rate": 0.1,
+    }
+}
+
+r = requests.post(
+    "https://data-mining-from-scratch-backend.onrender.com/",
+    json=request_params,
+)
+
+response_data = json.loads(r.json)
+print(response_data)
+
+```
+

app.py

@@ -26,22 +26,23 @@ def not_valid(params: dict):
 
 @app.route("/", methods=["POST", "GET"])
 def index():
-    if request.method == "POST":
-        params = request.json
-        error_message = not_valid(params=params)
-        if error_message:
-            return make_response(error_message, 400)
-
-        # parse arguments
-        algorithm = options[params["algorithm"]]
-        args = params["arguments"]
-
-        # in the future instead of a random data set
-        # we should do a more real one like palmer penguins
-        X, y = random_dataset(100, 10)
-        model = algorithm(X, y, args)
-        return jsonify(model)
-    return render_template("index.html")
+    if request.method == "GET":
+        return render_template("index.html")
+
+    params = request.json
+    error_message = not_valid(params=params)
+    if error_message:
+        return make_response(error_message, 400)
+
+    # parse arguments
+    algorithm = options[params["algorithm"]]
+    args = params["arguments"]
+
+    # in the future instead of a random data set
+    # we should do a more real one like palmer penguins
+    X, y = random_dataset(100, 10)
+    model = algorithm(X, y, args)
+    return jsonify(model)
 
 
 if __name__ == "__main__":