dtyago commited on
Commit
cd9bd48
β€’
1 Parent(s): d131d3b

Updated README

Browse files
Files changed (1) hide show
  1. README.md +4 -0
README.md CHANGED
@@ -32,7 +32,10 @@ EduConnect/
32
  β”‚ └── utils/
33
  β”‚ β”œβ”€β”€ __init__.py
34
  β”‚ β”œβ”€β”€ db.py # Centraized DB functions for ChromaDB collections, TinyDB
 
 
35
  β”‚ β”œβ”€β”€ jwt_utils.py # Utility for JWT tokens
 
36
  β”‚ └── ec_image_utils.py # Integrates MTCNN and Facenet for login authentication
37
  β”œβ”€β”€ static/
38
  β”‚ β”œβ”€β”€ css/ # CSS for the administration portal
@@ -40,5 +43,6 @@ EduConnect/
40
  β”‚ └── images/ # UI rendering images for administration page
41
  β”œβ”€β”€ Dockerfile # Docker configuration for setting up the environment
42
  β”œβ”€β”€ requirements.txt # Lists all Python library dependencies
 
43
  └── .env # Environment variables for configuration settings
44
  ```
 
32
  β”‚ └── utils/
33
  β”‚ β”œβ”€β”€ __init__.py
34
  β”‚ β”œβ”€β”€ db.py # Centraized DB functions for ChromaDB collections, TinyDB
35
+ β”‚ β”œβ”€β”€ chat_rag.py # LLM chat function with RAG from vector DB
36
+ β”‚ β”œβ”€β”€ doc_ingest.py # Utility to ingest pdf documents into vector DB
37
  β”‚ β”œβ”€β”€ jwt_utils.py # Utility for JWT tokens
38
+ β”‚ β”œβ”€β”€ download_model.py # Utility for downloading model from hugging face
39
  β”‚ └── ec_image_utils.py # Integrates MTCNN and Facenet for login authentication
40
  β”œβ”€β”€ static/
41
  β”‚ β”œβ”€β”€ css/ # CSS for the administration portal
 
43
  β”‚ └── images/ # UI rendering images for administration page
44
  β”œβ”€β”€ Dockerfile # Docker configuration for setting up the environment
45
  β”œβ”€β”€ requirements.txt # Lists all Python library dependencies
46
+ β”œβ”€β”€ entrypoint.sh
47
  └── .env # Environment variables for configuration settings
48
  ```