소스 검색

Added readme

Min 2 년 전
부모
커밋
b761e46eff
1개의 변경된 파일25개의 추가작업 그리고 0개의 파일을 삭제
  1. 25 0
      README.md

+ 25 - 0
README.md

@@ -0,0 +1,25 @@
+# Question Matcher
+
+Backend + website frontend for finding questions that are similar in meaning within database. Search is based on 
+sentence transformers which are comparable to cosine-similarity. 
+By default, a general [large-instructor](https://huggingface.co/hkunlp/instructor-large) model is used.
+
+## Setup
+
+Build frontend
+```shell
+cd web
+yarn install
+yarn run build
+```
+
+Get backend stuff
+``` shell
+python -m venv env
+source env/bin/activate 
+pip install -U pip wheel
+pip install -r requirements.txt
+
+# Run
+python main.py
+```