Moves test routes to their respective modules and adds some docs.

Author: wilkie

src/__init__.py

@@ -1,9 +1,6 @@
 # Main imports
 import os
 
-# Our assessment code
-from lib import assess
-
 # Our modules
 from src.test import test_routes
 from src.openai import openai_routes

src/assessment.py

@@ -1,13 +1,20 @@
+# These routes (/assessment) issue AI driven rubric assessments.
+# The /test/assessment will issue a hard-coded AI assessment of a rubric.
+
 from flask import Blueprint, request
 
 import os
 import openai
 
+# Our assessment code
+from lib import assess
+
 assessment_routes = Blueprint('assessment_routes', __name__)
 
 # Get the status of a rubric assessment
 @assessment_routes.route('/assessment', methods=['GET'])
 def get_assessment():
+    # So far, we don't persist the results in any memory store, here.
     return {}
 
 # Submit a rubric assessment
@@ -45,3 +52,39 @@ def post_assessment():
         return "response from AI or service not valid", 400
 
     return grades
+
+# Submit a test rubric assessment
+@assessment_routes.route('/test/assessment', methods=['GET','POST'])
+def test_assessment():
+    openai.api_key = os.getenv('OPENAI_API_KEY')
+    
+    with open('test/data/u3l23_01.js', 'r') as f:
+        code = f.read()
+
+    with open('test/data/u3l23.txt', 'r') as f:
+        prompt = f.read()
+
+    with open('test/data/u3l23.csv', 'r') as f:
+        rubric = f.read()
+
+    try:
+        grades = assess.grade(
+            code=code,
+            prompt=prompt,
+            rubric=rubric,
+            api_key=request.values.get("api-key", openai.api_key),
+            llm_model=request.values.get("model", "gpt-4"),
+            remove_comments=(request.values.get("remove-comments", "0") != "0"),
+            num_responses=int(request.values.get("num-responses", "1")),
+            temperature=float(request.values.get("temperature", "0.2")),
+            num_passing_grades=int(request.values.get("num-passing-grades", "2")),
+        )
+    except ValueError:
+        return "One of the arguments is not parseable as a number", 400
+    except openai.error.InvalidRequestError as e:
+        return str(e), 400
+
+    if not isinstance(grades, list):
+        return "response from AI or service not valid", 400
+
+    return grades

src/openai.py

@@ -1,3 +1,8 @@
+# These routes (/openai) will query the OpenAI API with the configured API key.
+# This is useful for using the OpenAI API to determine metrics and usage data.
+# Right now, we can query the list of models available. (/openai/models)
+# The '/test/openai' route will query the given chat model with a small prompt.
+
 from flask import Blueprint
 
 import os
@@ -10,3 +15,24 @@
 def get_openai_models():
     openai.api_key = os.getenv('OPENAI_API_KEY')
     return openai.Model.list().data
+
+# Submit a test prompt
+@openai_routes.route('/test/openai', methods=['GET','POST'])
+def test_openai():
+    openai.api_key = os.getenv('OPENAI_API_KEY')
+
+    try:
+        completion = openai.ChatCompletion.create(
+            model=request.values.get("model", "gpt-3.5-turbo"),
+            api_key=request.values.get("api-key", openai.api_key),
+            messages=[
+                {
+                    "role": "user",
+                    "content": "Hello world"
+                }
+            ]
+        )
+    except openai.error.InvalidRequestError as e:
+        return str(e), 400
+
+    return completion.choices[0].message

src/test.py

@@ -1,8 +1,7 @@
-from flask import Blueprint, request
+# This houses generic tests of supplemental libraries and health
+# of the service.
 
-import os
-import openai
-import numpy
+from flask import Blueprint, request
 
 test_routes = Blueprint('test_routes', __name__)
 
@@ -14,6 +13,7 @@ def test():
 # Test numpy integration
 @test_routes.route('/test/numpy')
 def test_numpy():
+    import numpy
     response = []
 
     x = numpy.asarray([[1, 2, 3], [4, 5, 6]])
@@ -24,60 +24,3 @@ def test_numpy():
     response.append(str(x.reshape([3, 2])))
 
     return "\n<br>\n".join(response)
-
-# Submit a test prompt
-@test_routes.route('/test/openai', methods=['GET','POST'])
-def test_openai():
-    openai.api_key = os.getenv('OPENAI_API_KEY')
-
-    try:
-        completion = openai.ChatCompletion.create(
-            model=request.values.get("model", "gpt-3.5-turbo"),
-            api_key=request.values.get("api-key", openai.api_key),
-            messages=[
-                {
-                    "role": "user",
-                    "content": "Hello world"
-                }
-            ]
-        )
-    except openai.error.InvalidRequestError as e:
-        return str(e), 400
-
-    return completion.choices[0].message
-
-# Submit a test rubric assessment
-@test_routes.route('/test/assessment', methods=['GET','POST'])
-def test_assessment():
-    openai.api_key = os.getenv('OPENAI_API_KEY')
-    
-    with open('test/data/u3l23_01.js', 'r') as f:
-        code = f.read()
-
-    with open('test/data/u3l23.txt', 'r') as f:
-        prompt = f.read()
-
-    with open('test/data/u3l23.csv', 'r') as f:
-        rubric = f.read()
-
-    try:
-        grades = assess.grade(
-            code=code,
-            prompt=prompt,
-            rubric=rubric,
-            api_key=request.values.get("api-key", openai.api_key),
-            llm_model=request.values.get("model", "gpt-4"),
-            remove_comments=(request.values.get("remove-comments", "0") != "0"),
-            num_responses=int(request.values.get("num-responses", "1")),
-            temperature=float(request.values.get("temperature", "0.2")),
-            num_passing_grades=int(request.values.get("num-passing-grades", "2")),
-        )
-    except ValueError:
-        return "One of the arguments is not parseable as a number", 400
-    except openai.error.InvalidRequestError as e:
-        return str(e), 400
-
-    if not isinstance(grades, list):
-        return "response from AI or service not valid", 400
-
-    return grades