dockerize the app

.gitattributes

@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,4 @@
+venv
+outputs
+.cache
+debug

Dockerfile

@@ -0,0 +1,25 @@
+FROM python:3.9-slim
+
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+
+WORKDIR /app
+
+# Required for OpenCV image display & ultralytics
+RUN apt-get update && apt-get install -y \
+    libgl1 \
+    libglib2.0-0 \
+    git \
+    curl \
+    && rm -rf /var/lib/apt/lists/*
+
+COPY requirements.txt .
+
+RUN pip install --upgrade pip \
+    && pip install --no-cache-dir -r requirements.txt
+
+COPY . .
+
+EXPOSE 7860
+
+CMD ["python", "app.py"]

README.md

@@ -3,7 +3,7 @@ title: Contour Detection Paper
 emoji: 👀
 colorFrom: pink
 colorTo: blue
-sdk: gradio
+sdk: docker
 # sdk_version: 5.41.1
 sdk_version: 5.42.0
 python_version: 3.12.0

app.py

@@ -1032,43 +1032,83 @@ def predict_full_paper(image, paper_size, offset_value_mm = 0.02,offset_unit='mm
         scale_info  # Always return scaling info
     )
 
+# ---------------------
+# Documentation Strings for Gradio
+# ---------------------
+
+QUICK_START_PAPER = """
+## 1. Quick Start Guide: From Photo to DXF Cut File
+This application converts a photograph of a single object placed on a sheet of standard paper (A4, A3, or US Letter) into a precise DXF contour file for CNC cutting. The paper acts as the scale reference.
+
+1.  **Preparation**: Place **only one object** (tool, part, etc.) flat on a sheet of A4, A3, or US Letter paper. Ensure the paper is fully visible and the object is fully within the boundaries of the paper. Use clear, overhead lighting.
+2.  **Upload**: Upload the image in the **Input Image** box.
+3.  **Configure**: Select the correct `Paper Size`. The default clearance is **0.02 mm** with **Finger Cuts Off**.
+4.  **Run**: Click the **"Generate DXF"** button.
+5.  **Download**: Review the previews, then download the final **DXF file** containing the object's profile, accurately scaled.
+"""
+
+INPUT_EXPLANATION_PAPER = """
+## 2. Expected Inputs
+### Image Requirements
+*   **Paper is Mandatory:** The system uses the known dimensions of the standard paper size (A4, A3, or US Letter) to calculate the real-world scale (mm/pixel).
+*   **Single Object Only:** The system is designed to detect and contour only **one** significant object on the paper. Multiple objects or major fragments will cause an error.
+*   **Placement & Lighting:** The image should be taken from directly above (minimal perspective distortion). Clear, shadow-free lighting is essential.
+### Processing Parameters (Hardcoded Default Values)
+| Parameter | Purpose | Default Value | Guidance for Non-Tech Clients |
+| :--- | :--- | :--- | :--- |
+| **Paper Size** | The exact size of the paper sheet used in the image. | A4 | Must match the paper you used for accurate scaling. |
+| **Offset Value** | The amount of space (clearance) added around the object profile. | **0.02 mm** | This minimal buffer ensures the cut is slightly larger than the object. (Cannot be changed in the UI) |
+| **Finger Cuts** | Adds a small circular cutout for easy object removal. | **Off** | Cannot be changed in the UI. |
+"""
+
+OUTPUT_EXPLANATION_PAPER = """
+## 3. Expected Outputs
+| Output Field | Description | Purpose |
+| :--- | :--- | :--- |
+| **DXF file** | The final vector file containing the object's profile. All coordinates are in millimeters (MM). | Ready to upload to CNC machine software (AutoCAD DXF R2000 format). |
+| **Scaling Information**| The calculated real-world scale (mm per pixel) determined by the paper reference, plus the offset settings. | Confirmation of measurement accuracy. |
+| **Annotated Image** | The original image overlaid with the final generated outline (including offset and finger cuts). | Visual confirmation that the detection and sizing are correct relative to the original photo. |
+| **Outlines**| A clean, scaled, white-background image showing only the outlines (black lines). This visually represents the final geometry exported to the DXF. | Final quality check for shape before CNC cutting. |
+| **Mask (Technical)** | The binary image used internally to generate the contours after applying segmentation. | Technical output for debugging segmentation issues. |
+"""
+
 # Gradio Interface
 if __name__ == "__main__":
     os.makedirs("./outputs", exist_ok=True)
+    os.makedirs("./debug", exist_ok=True) 
+
+    # Define HIDDEN inputs for the function signature, as requested.
+    # These mimic the original inline hardcoded values.
+    # NOTE: We must use named variables so gr.Examples can reference them.
+    hidden_offset_value = gr.Number(value=0.02, visible=False, label="Hidden Offset Value")
+    hidden_offset_unit = gr.Textbox(value='mm', visible=False, label="Hidden Offset Unit")
+    hidden_enable_finger_cut = gr.Textbox(value='Off', visible=False, label="Hidden Finger Cut")
+
 
     with gr.Blocks(title="Paper-Based DXF Generator", theme=gr.themes.Soft()) as demo:
-         # Example gallery
-        gr.Markdown("""
-            # Paper-Based DXF Generator
-            
-            Upload an image with a single object placed on paper (A4, A3, or US Letter).
-            The paper serves as a size reference for accurate DXF generation.
-            """)
-        with gr.Row():
-            gr.Markdown("""
-            **Instructions:**
-            1. Place a single object on paper
-            2. Select the correct paper size
-            3. Configure options as needed
-            4. Click Submit to generate DXF
-            """)
-            gr.Markdown("""
-            ### Tips for Best Results:
-            - Ensure good lighting and clear paper edges
-            - Place object completely at the center of the paper
-            - Avoid shadows that might interfere with detection
-            - Use high contrast between object and paper
-            """)
+        
+        gr.Markdown("<h1 style='text-align: center;'> Paper-Based DXF Generator </h1>")
+        gr.Markdown("Upload an image with a single object placed on standard paper (A4, A3, or US Letter). The paper serves as the scale reference.")
+
+        # 1. Guidelines & Instructions (Integrated Documentation)
+        with gr.Accordion("Tips & User Guide", open=False):
+            gr.Markdown(QUICK_START_PAPER)
+            gr.Markdown("---")
+            gr.Markdown(INPUT_EXPLANATION_PAPER)
+            gr.Markdown("---")
+            gr.Markdown(OUTPUT_EXPLANATION_PAPER)
         
         
         with gr.Row():
             with gr.Column():
+                gr.Markdown("## Step 1: Upload Image ")
                 input_image = gr.Image(
                     label="Input Image (Object on Paper)", 
                     type="numpy",
                     height=400
                 )
-                
+            with gr.Column():
+                gr.Markdown("## Step 2: Select Paper Size & Preview Outputs")
                 paper_size = gr.Radio(
                     choices=["A4", "A3", "US Letter"],
                     value="A4",
@@ -1076,42 +1116,23 @@ if __name__ == "__main__":
                     info="Select the paper size used in your image"
                 )
                 
-                # with gr.Group():
-                #     gr.Markdown("### Contour Offset")
-                #     with gr.Row():
-                #         offset_value_mm = gr.Number(
-                #             value=0.02,
-                #             label="Offset",
-                #             info="Expand contours outward by this amount",
-                #             precision=3,
-                #             minimum=0,
-                #             maximum=50
-                #         )
-                #         offset_unit = gr.Dropdown(
-                #             choices=["mm", "inches"],
-                #             value="mm",
-                #             label="Unit"
-                #         )
-
-                # with gr.Group():
-                #     gr.Markdown("### Finger Cuts")
-                #     enable_finger_cut = gr.Radio(
-                #         choices=["On", "Off"],
-                #         value="Off",
-                #         label="Enable Finger Cuts",
-                #         info="Add circular cuts for easier handling"
-                #     )
+                # Hidden components are defined but not visible in the UI layout
                 
                 output_options = gr.CheckboxGroup(
                     choices=["Annotated Image", "Outlines", "Mask"],
-                    value=[],
+                    value=["Annotated Image", "Outlines"],
                     label="Additional Outputs",
                     info="DXF is always included"
                 )
                 
+        with gr.Row():
+            with gr.Column():
+                gr.Markdown("## Step 3: Click Generate DXF ")  
                 submit_btn = gr.Button("Generate DXF", variant="primary", size="lg")
             
+        with gr.Row():
             with gr.Column():
+                gr.Markdown("## Outputs ")  
                 with gr.Group():
                     gr.Markdown("### Generated Files")
                     dxf_file = gr.File(label="DXF File", file_types=[".dxf"])
@@ -1119,8 +1140,8 @@ if __name__ == "__main__":
                 
                 with gr.Group():
                     gr.Markdown("### Preview Images")
-                    output_image = gr.Image(label="Annotated Image", visible=False)
-                    outlines_image = gr.Image(label="Outlines", visible=False) 
+                    output_image = gr.Image(label="Annotated Image", visible=True)
+                    outlines_image = gr.Image(label="Outlines", visible=True) 
                     mask_image = gr.Image(label="Mask", visible=False)
         
         def update_outputs_visibility(selected):
@@ -1150,6 +1171,25 @@ if __name__ == "__main__":
             outputs=[dxf_file, output_image, outlines_image, mask_image, scale_info]
         )
         
+        # 4. Examples Section
+        gr.Markdown("---")
+        gr.Markdown("## Examples")
+        gr.Examples(
+            examples=[
+                # [Input Image Path, Paper Size, Selected Outputs]
+                # NOTE: The image paths below are placeholders. Ensure these files exist in ./examples/
+                ["./sample_data/papertest1.jpg", "A4", ["Annotated Image", "Outlines"]],
+                ["./sample_data/papertest2.jpg", "US Letter", ["Annotated Image", "Outlines", "Mask"]],
+                ["./sample_data/papertest3.jpg", "A3", ["Annotated Image", "Outlines"]],
+            ],
+            inputs=[input_image, paper_size, output_options],
+            label="Click an example to load the image and configuration. Then click 'Generate DXF'."
+        )
+
        
 
-    demo.launch(share=True)
+    demo.launch(
+        server_name = "0.0.0.0",
+        server_port=7860
+    )
+

requirements.txt

@@ -5,12 +5,16 @@ pydantic==2.10.6
 opencv-python-headless>=4.8.0
 opencv-contrib-python-headless>=4.8.0
 ezdxf==1.3.5
-gradio==5.15.0
 kornia==0.8.0
 timm==1.0.14
 einops==0.8.1
-torchvision==0.20.1
-torch==2.5.1
-torchaudio==2.5.1
+torch==2.2.2
+torchaudio==2.2.2
+torchmetrics==1.8.2
+torchvision==0.17.2
 shapely
-git+https://github.com/ultralytics/CLIP.git
+git+https://github.com/ultralytics/CLIP.git
+Pillow
+numpy<2
+gradio==3.50.2 
+gradio-client==0.6.1