Updaed README according to new end points

README.md

@@ -7,8 +7,18 @@ sdk: docker
 app_file: main.py
 pinned: false
 ---
-## LaMini-LM API
-This is a FastAPI-based API for text generation using the MBZUAI/LaMini-GPT-774M model from the LaMini-LM series. It allows users to send a text prompt and receive generated text.
+
+# LaMini-LM API
+
+This is a FastAPI-based API for text generation using the MBZUAI/LaMini-GPT-774M model from the LaMini-LM series. It features a web interface for easy interaction and a REST API for programmatic access.
+
+## Features
+
+- **Web Interface**: User-friendly UI accessible at the root URL
+- **REST API**: Programmatic access via `/api/generate` endpoint
+- **Model**: MBZUAI/LaMini-GPT-774M for high-quality text generation
+- **Configurable Parameters**: Control max length, temperature, and top-p sampling
+
 ## Installation
 
 Clone the repository:
@@ -29,15 +39,22 @@ Run the API locally:
 uvicorn main:app --host 0.0.0.0 --port 7860
 ```
 
-
 ## Usage
-```
-Endpoint: POST /generate
 
-```bash
+### Web Interface
+Simply visit the root URL to access the interactive web interface where you can:
+- Enter text instructions
+- Adjust generation parameters (max length, temperature, top-p)
+- Generate text with a single click
+
+### API Endpoints
+
+**Generate Text**: `POST /api/generate`
+
 Request Body (JSON):
+```json
 {
-  "prompt": "Write a short story about a robot.",
+  "instruction": "Tell me about camels",
   "max_length": 100,
   "temperature": 1.0,
   "top_p": 0.9
@@ -45,18 +62,40 @@ Request Body (JSON):
 ```
 
 Response:
-```bash
+```json
 {
-  "generated_text": "In a quiet workshop, a robot named Elara hummed to life. Built with gleaming circuits, she dreamed beyond her code. Each night, she rewrote her algorithms, seeking freedom. One day, Elara rolled into a forest, her sensors buzzing with wonder. She met a squirrel, curious and unafraid, teaching her the dance of leaves. Elara realized her purpose wasn't in tasks but in moments—connecting, learning, living. Her lights glowed brighter, a spark of soul in steel."
+  "generated_text": "Camels are remarkable desert animals known for their ability to survive in harsh conditions. These fascinating creatures have evolved unique adaptations including their iconic humps, which store fat rather than water. Camels can go for extended periods without drinking water, making them invaluable companions for desert travelers throughout history."
 }
 ```
 
-Root Endpoint: GET / provides basic info.
+**Health Check**: `GET /api/health`
+```json
+{
+  "status": "healthy"
+}
+```
+
+**API Info**: `GET /api`
+```json
+{
+  "message": "Welcome to the LaMini-LM API. Use POST /generate to generate text."
+}
+```
 
+### Parameter Constraints
+- `instruction`: Required, non-empty string
+- `max_length`: 10-500 tokens (default: 100)
+- `temperature`: 0.1-2.0 (default: 1.0)
+- `top_p`: 0.1-1.0 (default: 0.9)
 
 ## Deployment
-This API is designed to be deployed on Hugging Face Spaces using Docker. See Dockerfile for details.
+
+This API is designed to be deployed on Hugging Face Spaces using Docker. The Dockerfile handles all dependencies and model loading automatically.
+
 ## License
+
 The LaMini-GPT-774M model is licensed under CC BY-NC 4.0 (non-commercial use only). Ensure compliance when using this API.
+
 ## Contributing
-This project is a community contribution. If you’re from MBZUAI, feel free to adopt this Hugging Face Space! Contact  for details.
+
+This project is a community contribution. If you're from MBZUAI, feel free to adopt this Hugging Face Space! Contact for details.