fixes #78: Update model module documentation

model/__init__.py

@@ -1,3 +1,7 @@
+"""
+This module provides functions for requesting inferences from different models.
+"""
+
 from model.swin import request_inference_from_swin
 from model.seed_detector import request_inference_from_seed_detector
 from model.test import request_inference_from_test

model/seed_detector.py

@@ -1,6 +1,6 @@
 """
-This file contains the function that requests the inference and processes the data from
-the seed detector model.
+This file contains the function that requests the inference and processes
+the data from the seed detector model.
 """
 
 import io

model/six_seeds.py

@@ -1,9 +1,10 @@
 """
-This file contains the function that requests the inference and processes the data from
-the nachet-6seeds model.
+This file contains the function that requests the inference and processes
+the data from the nachet-6seeds model.
 """
 
 import json
+
 from collections import namedtuple
 from urllib.request import Request, urlopen, HTTPError
 from custom_exceptions import ProcessInferenceResultError

model/swin.py

@@ -1,6 +1,6 @@
 """
-This file contains the function that requests the inference and processes the data from
-the swin model.
+This file contains the function that requests the inference and processes
+the data from the swin model.
 """
 
 import json

model/test.py

@@ -1,10 +1,6 @@
 """
-This module contains functions for performing inference using different models.
-
-Functions:
-    request_inference_from_swin: Perform inference using the SWIN model on a list of images.
-    request_inference_from_seed_detector: Requests inference from the seed detector model using the provided previous result.
-    request_inference_from_nachet_six_seed: Requests inference from the Nachet Six Seed model.
+This module contains functions for testing the inference procedure in
+the backend.
 """
 from collections import namedtuple
 from custom_exceptions import ProcessInferenceResultError