Update README.md

README.md

@@ -35,4 +35,35 @@ The model is trained to identify tokens in the answer text that are not supporte
 
 ### Installation
 
-Install the 'lettucedetect' repository
+Install the 'lettucedetect' repository
+
+```bash
+pip install lettucedetect
+```
+
+### Using the model
+
+```python
+from lettucedetect.models.inference import HallucinationDetector
+
+# Initialize the detector with the transformer-based approach.
+detector = HallucinationDetector(method="transformer", model_path="KRLabsOrg/lettucedect-base-modernbert-en-v1")
+
+
+context = """Briefly answer the following question:
+What is the capital of France? What is the population of France?
+
+Bear in mind that your response should be strictly based on the following three passages:
+passage 1: France is a country in Europe. The capital of France is Paris. The population of France is 67 million.
+
+output:
+"""
+
+answer = "The capital of France is Paris. The population of France is 69 million."
+
+# Get span-level predictions indicating which parts of the answer are considered hallucinated.
+predictions = detector.predict(context, answer, output_format="spans")
+print("Predictions:", predictions)
+
+# Predictions: [{'start': 31, 'end': 71, 'confidence': 0.9944414496421814, 'text': ' The population of France is 69 million.'}]
+```