chg ! dedup engine

.dockerignore

@@ -0,0 +1,3 @@
+*
+!pyproject.toml
+!pdm.lock

.gitignore

@@ -1,6 +1,6 @@
 .*
 ~*
+__pycache__
 
 !.github
-
-__pycache__
+!.dockerignore

README.md

@@ -17,3 +17,7 @@ add in your .envrc
 #### Start
     $ mkdocs build
     $ mkdocs serve
+
+#### Using Docker compose
+
+    $ docker compose up

compose.yml

@@ -0,0 +1,10 @@
+services:
+
+  mkdocs:
+    build:
+      context: .
+      dockerfile: docker/Dockerfile
+    ports:
+      - "8000:8000"
+    volumes:
+      - .:/app

docker/Dockerfile

@@ -0,0 +1,19 @@
+FROM python:3.12-slim
+
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+       git \
+       libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+
+COPY pyproject.toml pdm.lock /app/
+
+RUN pip install -U pip pdm \
+    && pdm venv create --name for-dev 3.12 \
+    && pdm sync --venv for-dev \
+    && rm -rf ~/.cache/pip ~/.cache/pdm
+
+CMD ["pdm", "run", "mkdocs", "serve", "-a", "0.0.0.0:8000", "--no-strict"]

docs/components/hde/deduplication_description.md

@@ -0,0 +1 @@
+It provides users with powerful capabilities to identify and remove duplicate records within the system, ensuring that data remains clean, consistent, and reliable.

docs/components/hde/development.md

@@ -3,6 +3,7 @@
 To develop the service locally, you can utilize the provided `compose.yml` file. This configuration file defines all the necessary services, including the primary application and its dependencies, to create a consistent development environment. By using **Docker Compose**, you can effortlessly spin up the entire application stack, ensuring that all components work seamlessly together.
 
 To build and start the service, along with its dependencies, run the following command:
+
     docker compose up --build
 
 

docs/components/hde/did/workflow.md

@@ -1,3 +1,8 @@
+---
+tags:
+  - Deduplication
+---
+
 The Image Processing and Duplicate Detection workflow is designed to provide reliable face detection, recognition, and duplicate detection by leveraging a pre-trained deep learning model.
 
 ## Inference Mode Operation

docs/components/hde/index.md

@@ -1,7 +1,8 @@
 # Deduplication
 
-Deduplication Engine component of the HOPE ecosystem. It provides users with powerful capabilities to identify and remove duplicate records within the system, ensuring that data remains clean, consistent, and reliable.
+Deduplication Engine component of the HOPE ecosystem.
 
+--8<-- "components/hde/deduplication_description.md"
 
 ## Repository
 

docs/components/hde/setup.md

@@ -1,3 +1,8 @@
+---
+tags:
+  - Deduplication
+---
+
 ## Prerequisites
 
 This project utilizes [PDM](https://pdm-project.org/) as the package manager for managing Python dependencies and environments. 
@@ -78,7 +83,7 @@ This backend is used for storing locally downloaded DNN model files and encoded
 #####  FILE_STORAGE_DNN
 This backend is dedicated to storing DNN model files. Ensure that the following two files are present in this storage:
 
-1. *deploy.prototxt*: Defines the model architecture.
+1. *deploy.prototxt.txt*: Defines the model architecture.
 2. *res10_300x300_ssd_iter_140000.caffemodel*: Contains the pre-trained model weights.
 
 The current process involves downloading files from a [GitHub repository](https://github.com/sr6033/face-detection-with-OpenCV-and-DNN) and saving them to this specific Azure Blob Storage using command `django-admin upgrade --with-dnn-setup`, or the specialized`django-admin dnnsetup` command .

docs/components/hde/troubleshooting.md

@@ -2,4 +2,5 @@ If you encounter issues while running the service, the **admin panel** can be a
 
 To efficiently track and monitor errors within the application, **Sentry** is integrated as the primary tool for error logging and alerting.
 
-For Sentry to work correctly, ensure that the **SENTRY_DSN** environment variable is set.
+!!! warning "Sentry environment"
+    For Sentry to work correctly, ensure that the **SENTRY_DSN** environment variable is set.

docs/glossary/terms/process.md

@@ -26,4 +26,6 @@ Sometimes used as a term pre-intervention to talk about who we are targeting.</p
 
 ## Deduplication
 
+--8<-- "components/hde/deduplication_description.md"
+
 #