Initial deploy

Dockerfile

@@ -0,0 +1,32 @@
+# ── Imagen base ───────────────────────────────────────────────────────────────
+FROM python:3.10-slim
+
+# HF Spaces expone el puerto 7860
+ENV PORT=7860
+ENV NER_MODEL=en_core_web_sm
+
+# Directorio de trabajo
+WORKDIR /app
+
+# ── Dependencias del sistema ───────────────────────────────────────────────────
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    build-essential \
+    curl \
+    && rm -rf /var/lib/apt/lists/*
+
+# ── Dependencias Python ────────────────────────────────────────────────────────
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+
+# ── Modelo spaCy ──────────────────────────────────────────────────────────────
+# Cambia "en_core_web_sm" por tu modelo si usas uno propio.
+# Si tienes un modelo local, cópialo con: COPY models/ ./models/
+RUN python -m spacy download en_core_web_sm
+
+# ── Código de la app ──────────────────────────────────────────────────────────
+COPY api_ner.py .
+
+# ── Puerto y arranque ─────────────────────────────────────────────────────────
+EXPOSE 7860
+
+CMD ["uvicorn", "api_ner:app", "--host", "0.0.0.0", "--port", "7860"]

README.md

@@ -1,10 +1,65 @@
 ---
-title: Lancaster Ner Api
-emoji: 🐠
-colorFrom: green
-colorTo: green
+title: Lancaster NER API
+emoji: 🏷️
+colorFrom: blue
+colorTo: indigo
 sdk: docker
+app_port: 7860
 pinned: false
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Lancaster NER API
+
+API REST construida con **FastAPI** y **spaCy** para detección de entidades nombradas (NER).
+
+## Endpoints
+
+### `GET /`
+Health check — confirma que el modelo está cargado.
+
+### `POST /annotate`
+Recibe un archivo `.txt` y devuelve las anotaciones NER.
+
+**Ejemplo con curl:**
+```bash
+curl -X POST "https://<tu-usuario>-lancaster-ner-api.hf.space/annotate" \
+     -F "file=@documento.txt"
+```
+
+**Respuesta:**
+```json
+{
+  "filename": "documento.txt",
+  "num_entities": 2,
+  "entities": [
+    {
+      "text": "London",
+      "label": "GPE",
+      "label_description": "Countries, cities, states",
+      "start": 5,
+      "end": 11
+    }
+  ],
+  "tokens": [...],
+  "html_visualization": "<div>...</div>"
+}
+```
+
+### `POST /annotate/text`
+Alternativa para enviar texto directamente como JSON.
+
+```bash
+curl -X POST "https://<tu-usuario>-lancaster-ner-api.hf.space/annotate/text" \
+     -H "Content-Type: application/json" \
+     -d '{"text": "John lives in New York."}'
+```
+
+## Documentación interactiva
+
+Disponible en `/docs` (Swagger UI) y `/redoc`.
+
+## Modelo
+
+Por defecto usa `en_core_web_sm` de spaCy. Para usar un modelo propio,
+sube los archivos del modelo a la carpeta `models/` y ajusta la variable
+de entorno `NER_MODEL` en la configuración del Space.

api_ner.py

@@ -0,0 +1,184 @@
+#!/usr/bin/env python
+# coding: utf-8
+"""
+FastAPI endpoint para el proyecto lanc-ner
+Recibe un archivo .txt y devuelve las anotaciones NER en formato JSON.
+
+Uso:
+    uvicorn api_ner:app --host 0.0.0.0 --port 8000 --reload
+
+Endpoint:
+    POST /annotate
+    - Body: multipart/form-data con campo "file" (archivo .txt)
+    - Respuesta: JSON con anotaciones NER
+"""
+
+from fastapi import FastAPI, File, UploadFile, HTTPException
+from fastapi.responses import JSONResponse
+import spacy
+from spacy import displacy
+import os
+import logging
+from typing import Optional
+
+# ── Logging ──────────────────────────────────────────────────────────────────
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+# ── App ───────────────────────────────────────────────────────────────────────
+app = FastAPI(
+    title="Lancaster NER API",
+    description="Recibe un documento .txt y devuelve sus anotaciones NER.",
+    version="1.0.0",
+)
+
+# ── Carga del modelo spaCy ────────────────────────────────────────────────────
+# Ajusta el nombre del modelo al que uses en tu proyecto (lanc-ner).
+# Si tienes un modelo entrenado propio en ./models/, cámbialo aquí:
+#   NLP_MODEL_PATH = "./models/mi_modelo"
+NLP_MODEL_PATH = os.getenv("NER_MODEL", "en_core_web_sm")
+
+try:
+    nlp = spacy.load(NLP_MODEL_PATH)
+    logger.info(f"Modelo cargado: {NLP_MODEL_PATH}")
+except OSError:
+    logger.error(
+        f"No se encontró el modelo '{NLP_MODEL_PATH}'. "
+        "Ejecuta: python -m spacy download en_core_web_sm"
+    )
+    nlp = None
+
+
+# ── Función NER (misma lógica que views/NER.py del repo) ─────────────────────
+def run_ner(text: str) -> dict:
+    """
+    Aplica el pipeline NER de spaCy sobre el texto y devuelve
+    un diccionario con:
+      - entities : lista de entidades detectadas
+      - tokens   : lista de todos los tokens con sus etiquetas IOB
+      - html     : visualización HTML (displaCy) — opcional
+    """
+    if nlp is None:
+        raise RuntimeError("El modelo NLP no está disponible.")
+
+    doc = nlp(text)
+
+    # Entidades detectadas
+    entities = [
+        {
+            "text": ent.text,
+            "label": ent.label_,
+            "label_description": spacy.explain(ent.label_) or "",
+            "start": ent.start_char,
+            "end": ent.end_char,
+        }
+        for ent in doc.ents
+    ]
+
+    # Tokens con etiquetas IOB
+    tokens = [
+        {
+            "token": token.text,
+            "pos": token.pos_,
+            "tag": token.tag_,
+            "dep": token.dep_,
+            "ent_iob": token.ent_iob_,
+            "ent_type": token.ent_type_,
+        }
+        for token in doc
+    ]
+
+    # Visualización HTML de displaCy (útil para depuración/front)
+    html = displacy.render(doc, style="ent", page=False, minify=True)
+
+    return {
+        "num_entities": len(entities),
+        "entities": entities,
+        "tokens": tokens,
+        "html_visualization": html,
+    }
+
+
+# ── Endpoints ─────────────────────────────────────────────────────────────────
+
+@app.get("/", tags=["Health"])
+def health_check():
+    """Comprueba que la API está en marcha."""
+    model_status = "loaded" if nlp is not None else "not loaded"
+    return {"status": "ok", "model": NLP_MODEL_PATH, "model_status": model_status}
+
+
+@app.post("/annotate", tags=["NER"])
+async def annotate(file: UploadFile = File(..., description="Archivo .txt a anotar")):
+    """
+    Recibe un archivo de texto plano (.txt) y devuelve las anotaciones
+    NER producidas por el modelo spaCy configurado en el proyecto.
+
+    **Respuesta JSON:**
+    ```json
+    {
+      "filename": "documento.txt",
+      "num_entities": 3,
+      "entities": [
+        {"text": "London", "label": "GPE", "label_description": "Countries, cities, states",
+         "start": 5, "end": 11}
+      ],
+      "tokens": [...],
+      "html_visualization": "<div>...</div>"
+    }
+    ```
+    """
+    # Validación del tipo de archivo
+    if not file.filename.lower().endswith(".txt"):
+        raise HTTPException(
+            status_code=415,
+            detail="Solo se aceptan archivos .txt",
+        )
+
+    # Lectura del contenido
+    try:
+        content_bytes = await file.read()
+        text = content_bytes.decode("utf-8")
+    except UnicodeDecodeError:
+        raise HTTPException(
+            status_code=422,
+            detail="No se pudo decodificar el archivo como UTF-8.",
+        )
+
+    if not text.strip():
+        raise HTTPException(
+            status_code=422,
+            detail="El archivo está vacío.",
+        )
+
+    # NER
+    try:
+        result = run_ner(text)
+    except RuntimeError as e:
+        raise HTTPException(status_code=503, detail=str(e))
+
+    return JSONResponse(
+        content={"filename": file.filename, **result}
+    )
+
+
+@app.post("/annotate/text", tags=["NER"])
+async def annotate_text(payload: dict):
+    """
+    Alternativa: envía el texto directamente como JSON.
+
+    **Body:**
+    ```json
+    { "text": "John lives in New York." }
+    ```
+    """
+    text = payload.get("text", "").strip()
+    if not text:
+        raise HTTPException(status_code=422, detail="El campo 'text' está vacío.")
+
+    try:
+        result = run_ner(text)
+    except RuntimeError as e:
+        raise HTTPException(status_code=503, detail=str(e))
+
+    return JSONResponse(content=result)

requirements.txt

@@ -0,0 +1,4 @@
+fastapi==0.111.0
+uvicorn[standard]==0.29.0
+python-multipart==0.0.9
+spacy==3.7.4