Evaluation Schema + a necessary revamp

.gitignore

@@ -1,15 +1,14 @@
-**/__pycache__
-**/CheckedOMRs
-**/ignore
-**/.DS_Store
-**/.vscode
-venv/
-.idea/
-OMRChecker.wiki/
+# Any directory starting with a dot
+**/\.*/
+# Except .github
+!.github/
+
 # Everything in inputs/ and outputs/
 inputs/*
 outputs/*
-# Except *.json and OMR_Files/
-# !inputs/OMR_Files/
-# !inputs/*.json
-# !inputs/omr_marker.jpg
+
+# Misc
+**/.DS_Store
+**/__pycache__
+venv/
+OMRChecker.wiki/

.pre-commit-config.yaml

@@ -4,6 +4,7 @@ repos:
     hooks:
     -   id: check-yaml
     -   id: end-of-file-fixer
+        exclude_types: ["csv", "json"]
     -   id: trailing-whitespace
 -   repo: https://github.com/pycqa/isort
     rev: 5.5.4
@@ -20,4 +21,4 @@ repos:
     -   id: flake8
         args:
             - "F401,F841"   # unused imports, unused variables
-            - "--ignore=E501,W503,E203"     # Line too long, Line break occurred before a binary operator, Whitespace before ':'
+            - "--ignore=E501,W503,E203,E741"     # Line too long, Line break occurred before a binary operator, Whitespace before ':'

README.md

@@ -220,20 +220,21 @@ Command: <code>python3 -m pip install --user --upgrade pip</code>
 ## Full Usage
 
 ```
-python3 main.py [--setLayout] [--autoAlign] [--inputDir dir1] [--outputDir dir1]
+python3 main.py [--setLayout] [--inputDir dir1] [--outputDir dir1]
 ```
 
 Explanation for the arguments:
 
 `--setLayout`: Set up OMR template layout - modify your json file and run again until the template is set.
 
-`--autoAlign`: (experimental) Enables automatic template alignment - use if the scans show slight misalignments.
-
 `--inputDir`: Specify an input directory.
 
 `--outputDir`: Specify an output directory.
 
-**Note:** The `--noCropping` flag has been replaced with including/excluding a 'CropPage' plugin in "preProcessors" of the template.json(see [samples](https://github.com/Udayraj123/OMRChecker/tree/master/samples)).
+**Notes:**
+
+- The old `--noCropping` flag has been replaced with the 'CropPage' plugin in "preProcessors" of the template.json(see [samples](https://github.com/Udayraj123/OMRChecker/tree/master/samples)).
+- The old `--autoAlign` flag can now be toggled from config.json
 
 <!-- #### Testing the code
 Datasets to test on :

main.py

@@ -7,15 +7,11 @@
 
 """
 
-from src.logger import logger
-
-logger.info(f"Loading OMRChecker modules...")
-# It takes a few seconds for the imports
-
 import argparse
 from pathlib import Path
 
-from src.core import entry_point
+from src.entry import entry_point
+from src.logger import logger
 
 # construct the argument parse and parse the arguments
 argparser = argparse.ArgumentParser()
@@ -41,17 +37,6 @@
     help="Specify an output directory.",
 )
 
-# TODO: separate the interactive modes from main code
-argparser.add_argument(
-    "-a",
-    "--autoAlign",
-    required=False,
-    dest="autoAlign",
-    action="store_true",
-    help="(experimental) Enables automatic template alignment - \
-    use if the scans show slight misalignments.",
-)
-
 argparser.add_argument(
     "-l",
     "--setLayout",

requirements.txt

@@ -1,7 +1,8 @@
-matplotlib>=3.3.1
-numpy>=1.16.1
-pandas>=1.1.1
-deepmerge>=0.1.0
-dotmap>=1.3.17
-jsonschema>=4.3.3
+deepmerge>=1.0.1
+dotmap>=1.3.30
+jsonschema>=4.16.0
+matplotlib>=3.5.3
+numpy>=1.23.2
+pandas>=1.4.3
 rich>=12.6.0
+screeninfo>=0.8.1

samples/community/Sandeep-1507/template.json

@@ -1,7 +1,5 @@
 {
   "Globals": {
-    "window_width": 1189,
-    "window_height": 1682,
     "display_width": 1189,
     "display_height": 1682
   },

samples/community/UPSC-mock/config.json

@@ -0,0 +1,11 @@
+{
+  "dimensions": {
+    "display_height": 1800,
+    "display_width": 2400,
+    "processing_height": 2400,
+    "processing_width": 1800
+  },
+  "outputs": {
+    "show_image_level": 0
+  }
+}

samples/community/UPSC-mock/evaluation.json

@@ -0,0 +1,12 @@
+{
+  "source_type": "csv",
+  "options": {
+      "answer_key_csv_path": "answer_key.csv",
+      "answer_key_image_path": "answer_key.jpg",
+      "questions_in_order": ["q1..100"],
+      "should_explain_scoring": true
+  },
+  "marking_scheme": {
+    "DEFAULT": {"correct": "2", "incorrect": "-2/3", "unmarked": "0" }
+  }
+}