Update README.md

README.md

@@ -1,14 +1,146 @@
----
-title: Pibit.ai Insurance Tokenizer
-emoji: 📉
-colorFrom: indigo
-colorTo: pink
-sdk: gradio
-sdk_version: 5.44.1
-app_file: app.py
-pinned: false
-license: mit
-short_description: BPE tokenizer for the Property & Casualty insurance industry
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+Pibit.ai Insurance Tokenizer: Live Demo & Examples
+Welcome to the interactive demo for the Pibit.ai Insurance Tokenizer, a tool designed to showcase the power of a domain-specific NLP model for the Property & Casualty insurance industry.
+
+Unlike generic models, this tokenizer understands the unique language of insurance—from loss runs to policy submissions. This demo allows you to test its capabilities on realistic, complex documents and see the detailed analysis it produces in real-time.
+
+How to Use the Demo 🚀
+It's simple to get started. Just follow these steps:
+
+Make sure you are on the "📊 Document Analysis" tab in the application.
+
+Choose one of the sample documents provided below.
+
+Click the copy button (📋) in the top-right corner of the document's text box.
+
+Paste the text into the main input area labeled "📄 Insurance Document Text".
+
+Click the "🔍 Analyze Document" button and see the results generate instantly.
+
+📋 Sample Documents for Analysis
+These examples have been crafted to test different features of the tokenizer, from entity recognition to risk assessment.
+
+Example 1: Detailed Loss Run Report (General Liability)
+This is a classic insurance document containing a mix of structured data, dates, and financial figures. It's a perfect test for core entity extraction and risk analysis.
+
+What to look for:
+
+Document Classification: The model should identify this as a Loss Run.
+
+Entity Recognition: Watch how it correctly extracts multiple <POLICY>, <DATE>, and <AMOUNT> tokens.
+
+Risk Score: The score will be elevated due to multiple open claims and high reserve amounts ($75,000 and $25,000).
+
+Plaintext
+
+CONFIDENTIAL LOSS RUN REPORT
+Insured: Precision Engineering & Fabrication LLC
+Policy Period: 01/01/2024 - 01/01/2025
+Policy Number: GL-98765B43
+Line of Business: General Liability
+
+As of Report Date: 09/05/2025
+
+----------------------------------------------------------------------
+Claim #: 2024-00182        Date of Loss: 02/15/2024      Status: Closed
+Claimant: John Doe
+Description: Slip and fall on wet floor near entrance. Claimant sustained a fractured wrist.
+Total Paid: $18,550.00
+Expense Paid: $3,200.00
+Reserve: $0.00
+Total Incurred: $21,750.00
+----------------------------------------------------------------------
+Claim #: 2024-00541        Date of Loss: 05/22/2024      Status: Open
+Claimant: Acme Retail Co.
+Description: Alleged product defect. A manufactured valve failed, causing water damage to claimant's inventory. Investigation ongoing.
+Total Paid: $0.00
+Expense Paid: $5,500.00
+Reserve: $75,000.00
+Total Incurred: $80,500.00
+----------------------------------------------------------------------
+Claim #: 2025-00012        Date of Loss: 08/19/2025      Status: Open - Reported Late
+Claimant: Jane Smith
+Description: Laceration from a sharp metal edge on a custom-fabricated part. Potential for litigation.
+Total Paid: $1,200.00 (Medical Payments)
+Expense Paid: $750.00
+Reserve: $25,000.00
+Total Incurred: $26,950.00
+----------------------------------------------------------------------
+
+Summary Totals:
+Total Paid Losses: $19,750.00
+Total Outstanding Reserves: $100,000.00
+Total Incurred: $129,200.00
+Example 2: Commercial Auto Submission 🚗
+This example demonstrates how the tokenizer handles a different line of business and parses information from an application, including specific coverage terms.
+
+What to look for:
+
+Document Classification: Should be correctly identified as a Submission.
+
+Key Terms: It will pick up domain-specific terms like commercial auto liability, deductible, and medical payments.
+
+Risk Score: The risk score should be relatively low due to a clean driving history and no hazardous material transport.
+
+Plaintext
+
+COMMERCIAL AUTO INSURANCE APPLICATION
+Applicant: Swift Logistics Inc.
+Address: 123 Freight Lane, Delhi, 110045
+Policy Effective Date Requested: 10/01/2025
+
+Business Operations: Regional transportation and delivery of dry goods. Radius of operations is 500km. No hazardous materials are transported.
+
+Driver Information:
+- All drivers have a minimum of 3 years commercial driving experience and clean MVRs.
+
+Vehicle Schedule:
+1. 2022 Tata Ultra T.7 - VIN: MA123456789XYZ001 - Cost New: ₹15,00,000
+2. 2023 Ashok Leyland Bada Dost - VIN: MB987654321ABC002 - Cost New: ₹9,50,000
+3. 2021 Eicher Pro 2049 - VIN: MC555444333DEF003 - Cost New: ₹11,00,000
+
+Requested Coverages:
+- Commercial Auto Liability: $1,000,000 Combined Single Limit
+- Physical Damage (Collision): $2,500 Deductible
+- Physical Damage (Comprehensive): $1,000 Deductible
+- Medical Payments: $5,000
+
+Loss History:
+- One minor backing accident in the last 3 years. Total Payout: $1,800 for property damage. No injuries reported.
+Example 3: Property Claim - First Notice of Loss (FNOL) ⛈️
+This document is highly unstructured and narrative-based. It tests the model's ability to extract meaning and assess risk from a descriptive text.
+
+What to look for:
+
+Document Classification: The model should classify this as a Claim report.
+
+Key Terms: It will identify risk-related words like damage, storm, water damage, and hole.
+
+Entity Recognition: The policy number, date, and estimated damage amount ($50,000) should be captured.
+
+Plaintext
+
+FIRST NOTICE OF LOSS - COMMERCIAL PROPERTY
+Policy Number: CP-A45-33-821
+Insured Name: "The Grand Heritage" Hotel
+Date of Loss: Approximately 09/04/2025 during the evening monsoon.
+
+Description of Loss:
+Severe monsoon storm with high winds and torrential rain caused significant damage. A large tree on the property was uprooted and fell onto the roof of our west wing, creating a large hole. Water has entered several guest rooms (Rooms 201, 203, 205) and the main banquet hall, causing extensive water damage to ceilings, walls, carpeting, and furniture. The electrical system in that wing has been shut down as a precaution.
+
+Estimated Damage:
+Initial estimate from our contractor, "Delhi Restoration Services," is upwards of $50,000 but a full assessment is pending. We are also expecting a significant business interruption loss as the wing is unusable.
+
+Any Injuries: No injuries to staff or guests have been reported.
+
+Contact Person: Mr. Arjun Singh (General Manager)
+Contact Number: +91-98XXXX-XXXX
+📊 Interpreting the Results
+After analyzing a document, you'll see several output components:
+
+Analysis Report: A summary that classifies the document, provides a risk score, and lists key token metrics.
+
+Risk Gauge & Token Pie Chart: Visualizations of the risk level and the ratio of insurance-specific terms to general terms.
+
+Detected Entities Table: A structured list of every policy number, financial amount, date, and percentage found in the text.
+
+Tokenization Sample: A preview showing exactly how the model breaks down the raw text into meaningful tokens.