Documentation review. (#5)
All checks were successful
build_docker / essential (push) Successful in 0s
build_docker / build_paddle_ocr (push) Successful in 5m28s
build_docker / build_paddle_ocr_gpu (push) Successful in 21m16s
build_docker / build_easyocr (push) Successful in 15m52s
build_docker / build_easyocr_gpu (push) Successful in 18m22s
build_docker / build_doctr (push) Successful in 19m3s
build_docker / build_raytune (push) Successful in 3m34s
build_docker / build_doctr_gpu (push) Successful in 13m56s

This commit was merged in pull request #5.
This commit is contained in:
2026-01-20 14:33:46 +00:00
committed by Sergio Jimenez Jimenez
parent c7ed7b2b9c
commit 9ee2490097
56 changed files with 2182 additions and 945 deletions

View File

@@ -0,0 +1,97 @@
Review and validate the documentation for this Master's Thesis project.
## Instructions
1. **Read metrics source files first** to get the correct values:
- `docs/metrics/metrics_paddle.md` - PaddleOCR results
- `docs/metrics/metrics_doctr.md` - DocTR results
- `docs/metrics/metrics_easyocr.md` - EasyOCR results
- `docs/metrics/metrics.md` - Comparative summary
- `src/results/*.csv` - Raw data from 64 trials per service
2. **Review UNIR guidelines** for formatting and structure rules:
- **`instructions/plantilla_individual.htm`** - **PRIMARY REFERENCE** for all styling (CSS classes, Word styles)
- **`instructions/plantilla_individual_files/`** - Support files with additional style definitions
- `instructions/instrucciones.pdf` - TFE writing instructions
- `instructions/plantilla_individual.pdf` - Official template preview
**IMPORTANT:** When styling elements (tables, figures, notes, quotes), ALWAYS check `plantilla_individual.htm` for existing Word/CSS classes (e.g., `MsoQuote`, `MsoCaption`, `Piedefoto-tabla`). Use these classes instead of custom inline styles.
### UNIR Color Palette (from plantilla_individual.htm)
| Color | Hex | Usage |
|-------|-----|-------|
| Primary Blue | `#0098CD` | Headings, titles, diagram borders |
| Light Blue BG | `#E6F4F9` | Backgrounds, callout boxes, nodes |
| Dark Gray | `#404040` | Primary text |
| Accent Blue | `#5B9BD5` | Table headers, accent elements |
| Light Accent | `#9CC2E5` | Table borders |
| Very Light Blue | `#DEEAF6` | Secondary backgrounds, subgraphs |
| White | `#FFFFFF` | Header text, contrast |
### Table Styles (from template)
- `MsoTableGrid` - Basic grid table
- `MsoTable15Grid4Accent1` - Styled table with UNIR colors (header: `#5B9BD5`, borders: `#9CC2E5`)
- `Piedefoto-tabla` - Table caption/source style
3. **Validate each documentation file** checking:
### Data Accuracy
- All CER/WER values must match those in `docs/metrics/*.md`
- Verify: baseline, optimized, best trial, percentage improvement
- Verify: GPU vs CPU acceleration factor
- Verify: dataset size (pages)
### UNIR Formatting
- Tables: `**Tabla N.** *Descriptive title in italics.*` followed by table, then `*Fuente: ...*`
- Table titles must describe the content (e.g., "Comparación de modelos OCR")
- Figures: `**Figura N.** *Descriptive title in italics.*`
- Figure titles must describe the content (e.g., "Pipeline de un sistema OCR moderno")
- Sequential numbering (no duplicates, no gaps)
- APA citation format for references
### Mermaid Diagrams
- **All diagrams must be in Mermaid format** (no external images for flowcharts/charts)
- All Mermaid diagrams must use the UNIR color theme
- Required YAML frontmatter config (Mermaid v11+):
```mermaid
---
title: "Diagram Title"
config:
theme: base
themeVariables:
primaryColor: "#E6F4F9"
primaryTextColor: "#404040"
primaryBorderColor: "#0098CD"
lineColor: "#0098CD"
---
flowchart LR
A[Node] --> B[Node]
```
- Colors: `#0098CD` (UNIR blue for borders/lines), `#E6F4F9` (light blue background)
- All diagrams must have a descriptive `title:` in YAML frontmatter
- Titles MUST be quoted: `title: "Descriptive Title"` (not `title: Descriptive Title`)
- Titles should describe the diagram content, not generic "Diagrama N"
- Verify theme is applied to all diagrams in `docs/*.md`
**Note on Bar Charts (`xychart-beta`):**
- Bar chart colors are **automatically converted to light blue** (`#0098CD`) during figure generation
- The `xyChart.plotColorPalette` config in YAML frontmatter does NOT work reliably with mmdc
- Instead, `generate_mermaid_figures.py` post-processes SVG to replace default colors (`#ECECFF`, `#FFF4DD`)
- No manual color configuration needed in xychart-beta blocks - they will be styled automatically
### Files to Review
- `docs/00_resumen.md` - Resumen/Abstract
- `docs/03_objetivos_metodologia.md` - Objectives
- `docs/04_desarrollo_especifico.md` - Main results (most critical)
- `docs/05_conclusiones_trabajo_futuro.md` - Conclusions
- `docs/07_anexo_a.md` - Technical annex
- `README.md` - Project overview
4. **Report findings** with:
- List of incorrect values found (with file:line references)
- Formatting issues detected
- Specific corrections needed
- Overall documentation health assessment
5. **Language**: All docs/* files must be in Spanish. README.md and CLAUDE.md can be in English.

View File

@@ -0,0 +1,77 @@
Generate the Word document for this Master's Thesis project.
## Instructions
Execute the TFM document generation pipeline in order:
### Step 0: Clean Up Previous Output
Remove the entire thesis_output folder to ensure a fresh build:
```bash
rm -rf thesis_output && mkdir -p thesis_output/figures
```
### Step 1: Generate Figures from Mermaid Diagrams
Run the figure generation script using the virtual environment:
```bash
source .venv/bin/activate && python3 generate_mermaid_figures.py
```
**Input:** Mermaid code blocks from `docs/*.md`
**Output:** `thesis_output/figures/figura_*.png` and `figures_manifest.json`
**Notes:**
- Bar charts (`xychart-beta`) are automatically post-processed to use light blue (`#0098CD`) bars
- The script generates SVG first, replaces default colors, then converts to PNG via `cairosvg`
- Other diagram types (flowchart, sequence, pie) use direct PNG generation via `mmdc`
### Step 2: Apply Content to UNIR Template
Run the content application script using the virtual environment:
```bash
source .venv/bin/activate && python3 apply_content.py
```
**Input:**
- `instructions/plantilla_individual.htm` (UNIR template)
- `instructions/plantilla_individual_files/` (template support files)
- `docs/*.md` (chapter content)
- `thesis_output/figures/*.png` (generated figures)
**Output:** `thesis_output/` (htm + support files + figures)
### Step 3: Report Results
After successful execution, provide:
1. Number of figures generated
2. Number of tables formatted
3. Path to output file
4. Instructions for Word finalization:
- Open `thesis_output/plantilla_individual.htm` in Microsoft Word
- Press Ctrl+A then F9 to update all indices (contents, figures, tables)
- Adjust image sizes if needed (select image → right-click → Size and Position)
- Save as `.docx`
### Prerequisites
If scripts fail, check that dependencies are installed:
```bash
# Python dependencies (in .venv)
source .venv/bin/activate && pip install beautifulsoup4 cairosvg
# Mermaid CLI for figure generation
npm install @mermaid-js/mermaid-cli
```
### Notes
- **Bar chart colors**: The `generate_mermaid_figures.py` script automatically converts xychart-beta bar colors to UNIR light blue (`#0098CD`). This is done via SVG post-processing since Mermaid's xychart theming doesn't work reliably via config files.
- **Color replacement**: Both `fill` and `stroke` attributes are replaced for colors `#ECECFF` and `#FFF4DD` (default Mermaid bar colors).
- **Config file**: `mermaid.config.json` in root directory sets the base theme for all diagrams.
### Error Handling
- If `generate_mermaid_figures.py` fails: Check mmdc (mermaid-cli) is installed
- If `apply_content.py` fails: Check beautifulsoup4 is installed
- Report any errors with the specific step that failed