refactor: v1.0

Makefile

@@ -1,15 +1,15 @@
 
 install:
-	pip install -r src/requirements.txt; cd src/client; npm  install
+	pip install -r src/backend/requirements.txt; cd src/frontend; npm  install
 
 python:
-	cd src; uvicorn main:app --reload
+	cd src/backend; uvicorn main:app --reload
 
 react:
-	cd src/client; npm start
+	cd src/frontend; npm start
 
 run-docker: 
-	cd src; docker run -d --rm --name sherlock-back -p 8000:8000 sherlock-back; cd client; docker run -d --rm --name sherlock-front -p 3000:3000 sherlock-front 
+	cd src/backend; docker run -d --rm --name sherlock-back -p 8000:8000 sherlock-back; cd ../frontend; docker run -d --rm --name sherlock-front -p 3000:3000 sherlock-front 
 
 stop-docker:
 	docker rmi sherlock-back; docker rmi sherlock-front

src/models/OurKmeans.py → src/backend/core/clustering/OurKmeans.py

@@ -1,5 +1,6 @@
 from cmath import sqrt
 
+
 class OurKmeans():
 
     def __init__(self, cluster_centers_, labels_):

src/models/kmeans_based_model.py → src/backend/core/clustering/kmeans_based_model.py

@@ -1,14 +1,14 @@
-from sklearn.cluster import KMeans
-from models.OurKmeans import OurKmeans
-from models.dict import Dict
-from models.vector_model import VectorModel
+import re
+import dictdatabase as ddb
 from collections import Counter
 from unidecode import unidecode
-import dictdatabase as ddb
-import re
 import matplotlib.pyplot as plt
-from models.vector_model import VectorModel
 from sklearn.cluster import KMeans
+from core.models.common.dict import Dict
+from core.clustering.OurKmeans import OurKmeans
+from core.models.vector_model import VectorModel
+from core.models.vector_model import VectorModel
+
 
 class VectorModelKMEANS(VectorModel):
 

src/models/relevance_feedback.py → src/backend/core/feedback/relevance_feedback.py

@@ -1,5 +1,6 @@
-from models.dict import Dict
-from models.vector_model import VectorModel
+from core.models.common.dict import Dict
+from core.models.vector_model import VectorModel
+
 
 class RelevanceFeedback:
 

src/models/base_model.py → src/backend/core/models/base_model.py

@@ -1,10 +1,8 @@
 from abc import abstractmethod
 from typing import List, Tuple
-
 import dictdatabase as ddb
-
-from models.corpus import Corpus
-from models.document import Document
+from core.models.common.corpus import Corpus
+from core.models.common.document import Document
 
 
 class BaseModel:

src/models/boolean_model.py → src/backend/core/models/boolean_model.py

@@ -2,8 +2,8 @@
 import dictdatabase as ddb
 from sympy import sympify
 from sympy.logic.boolalg import to_dnf
-from models.base_model import BaseModel
-from models.dict import Dict
+from core.models.base_model import BaseModel
+from core.models.common.dict import Dict
 
 
 class BooleanModel(BaseModel):

src/models/corpus.py → src/backend/core/models/common/corpus.py

@@ -1,9 +1,10 @@
 import ir_datasets
-from models.dict import Dict
-from models.document import Document
+from core.models.common.dict import Dict
+from core.models.common.document import Document
 
 
 class Corpus:
+
     def __init__(self, dataset):
         self.dict = Dict()
         self.dataset = ir_datasets.load(dataset)

src/models/dict.py → src/backend/core/models/common/dict.py

@@ -1,7 +1,6 @@
-from json import JSONEncoder
 
+class Dict:
 
-class Dict(JSONEncoder):
     def __init__(self, _dict = None):
         self.dict = {}
         if _dict != None:

src/models/document.py → src/backend/core/models/common/document.py

@@ -2,10 +2,11 @@
 from collections import Counter
 from typing import List
 from unidecode import unidecode
-from models.dict import Dict
+from core.models.common.dict import Dict
 
 
 class Document:
+
     def __init__(self, doc):        
         self.doc_id = doc.doc_id
 

src/models/fuzzy_model.py → src/backend/core/models/fuzzy_model.py

@@ -1,6 +1,6 @@
 import dictdatabase as ddb
 from time import time
-from models.boolean_model import BooleanModel
+from core.models.boolean_model import BooleanModel
 
 
 class FuzzyModel(BooleanModel):

src/models/vector_model.py → src/backend/core/models/vector_model.py

@@ -1,12 +1,12 @@
 import re
 from math import log
 import dictdatabase as ddb
-from models.dict import Dict
+from core.models.common.dict import Dict
 from typing import List, Tuple
 from unidecode import unidecode
 from collections import Counter
-from models.document import Document
-from models.base_model import BaseModel
+from core.models.common.document import Document
+from core.models.base_model import BaseModel
 
 class VectorModel(BaseModel):
 

src/main.py → src/backend/main.py

@@ -1,15 +1,13 @@
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 from pydantic import BaseModel
-from traitlets import FuzzyEnum
-from models.kmeans_based_model import  VectorModelKMEANS
-
-from models.boolean_model import BooleanModel
-from models.corpus import Corpus
-from models.fuzzy_model import FuzzyModel
-from models.vector_model import VectorModel
-from models.kmeans_based_model import VectorModelKMEANS
-from models.relevance_feedback import RelevanceFeedback
+from core.clustering.kmeans_based_model import  VectorModelKMEANS
+from core.models.boolean_model import BooleanModel
+from core.models.common.corpus import Corpus
+from core.models.fuzzy_model import FuzzyModel
+from core.models.vector_model import VectorModel
+from core.clustering.kmeans_based_model import VectorModelKMEANS
+from core.feedback.relevance_feedback import RelevanceFeedback
 import dictdatabase as ddb
 
 class DocumentDto(BaseModel):

src/requirements.txt → src/backend/requirements.txt

@@ -1,8 +1,11 @@
+os
+sys
+json
+typing
 fastapi
-uvicorn[standard]
 unidecode
+matplotlib
 ir_datasets
 dictdatabase
-typing
 scikit-learn
-matplotlib
+uvicorn[standard]

src/test/corpus_qrels.py → src/backend/test/corpus_qrels.py

@@ -1,6 +1,6 @@
 from qrels import QRels
 import dictdatabase as ddb
-from models.base_model import BaseModel
+from core.models.base_model import BaseModel
 
 
 class CranfieldQRels(QRels):

src/test/evaluation_plots.py → src/backend/test/evaluation_plots.py

@@ -1,5 +1,3 @@
-import numpy as np
-import matplotlib
 import json
 import matplotlib.pyplot as plt
 import os

src/test/qrels.py → src/backend/test/qrels.py

@@ -1,7 +1,7 @@
 from abc import abstractmethod
 import ir_datasets
 import dictdatabase as ddb
-from models.base_model import BaseModel
+from core.models.base_model import BaseModel
 
 
 class QRels:

src/test/test_boolean.py → src/backend/test/test_boolean.py

@@ -1,5 +1,5 @@
-from models.corpus import Corpus
-from models.boolean_model import BooleanModel
+from core.models.common.corpus import Corpus
+from core.models.boolean_model import BooleanModel
 from corpus_qrels import CranfieldQRels, VaswaniQRels, Cord19QRels
 
 # cranfield_Corpus = Corpus('cranfield')

src/test/test_fuzzy.py → src/backend/test/test_fuzzy.py

@@ -1,5 +1,5 @@
-from models.corpus import Corpus
-from models.fuzzy_model import FuzzyModel
+from core.models.common.corpus import Corpus
+from core.models.fuzzy_model import FuzzyModel
 from corpus_qrels import CranfieldQRels, VaswaniQRels, Cord19QRels
 
 cranfield_Corpus = Corpus('cranfield')

src/test/test_vector.py → src/backend/test/test_vector.py

@@ -1,5 +1,5 @@
-from models.corpus import Corpus
-from models.vector_model import VectorModel
+from core.models.common.corpus import Corpus
+from core.models.vector_model import VectorModel
 from corpus_qrels import CranfieldQRels, VaswaniQRels, Cord19QRels
 
 cranfield_Corpus = Corpus('cranfield')

src/test/test_vector_kmeans.py → src/backend/test/test_vector_kmeans.py

@@ -1,7 +1,7 @@
-from models.corpus import Corpus
-from models.kmeans_based_model import VectorModelKMEANS
+from core.models.common.corpus import Corpus
+from core.clustering.kmeans_based_model import VectorModelKMEANS
 from corpus_qrels import CranfieldQRels, VaswaniQRels, Cord19QRels
-from models.vector_model import VectorModel
+from core.models.vector_model import VectorModel
 
 # cranfield_Corpus = Corpus('cranfield')
 # cranfield_Vector = VectorModelKMEANS(cranfield_Corpus)