Create README.md

README.md

@@ -0,0 +1,56 @@
+---
+language: en
+license: apache-2.0
+tags:
+- token-classification
+- named-entity-recognition
+- ner
+- esg
+- sustainability
+- financial-ner
+- xbrl
+datasets:
+- custom
+metrics:
+- precision
+- recall
+- f1
+model-index:
+- name: esg-ner-sb253
+  results: []
+---
+
+# ESG/Financial NER Model (sb253)
+
+A custom Named Entity Recognition (NER) model trained for extracting key entities from ESG (Environmental, Social, and Governance) reports, sustainability documents, and financial statements.
+
+## Model Description
+
+This model identifies and classifies entities relevant to ESG reporting and financial analysis, supporting automated data extraction from sustainability reports, XBRL filings, and financial documents.
+
+**Model Architecture**: XLM-RoBERTa-based Token Classification  
+**Model Size**: ~800MB  
+**Training Domain**: ESG/Sustainability/Financial Reports  
+**Inference**: Optimized for CPU deployment on Google Cloud Run
+
+## Supported Entity Types
+
+| Entity Type | Description | Examples |
+|------------|-------------|----------|
+| **CONCEPT** | ESG concepts, metrics, and terminology | "carbon emissions", "renewable energy", "employee satisfaction" |
+| **VALUE** | Numerical values and amounts | "15%", "2.5 million", "50 tons" |
+| **UNIT** | Units of measurement | "CO2e", "USD", "percent", "GWh" |
+| **PERIOD** | Time periods and reporting dates | "Q4 2024", "fiscal year 2023", "January-March" |
+| **ENTITY** | Organizations, companies, subsidiaries | "Acme Corporation", "European Union", "Board of Directors" |
+| **CHANGE** | Change indicators and trends | "increased", "decreased", "reduced by", "grew" |
+
+## Usage
+
+### Deployment on Google Cloud Run
+
+The model is deployed as a FastAPI service with the following endpoints:
+
+**Base URL**: `https://ner-backend-171009084156.europe-west1.run.app`
+
+#### Endpoints
+```bash