Update README.md

README.md

@@ -1,5 +1,5 @@
 ---
-title: Ollama API
+title: Ollama Generate API
 emoji: 🦙
 colorFrom: blue
 colorTo: purple
@@ -8,51 +8,31 @@ pinned: false
 app_port: 7860
 ---
 
-# Ollama Model API
+# Ollama Generate API
 
-A REST API for running Ollama models on Hugging Face Spaces.
+A simple REST API for text generation using Ollama models on Hugging Face Spaces.
 
 ## Features
 
-- 🦙 Run Ollama models via REST API
-- 🔄 Model management (pull, list, delete)
-- 💬 Chat completions
-- 🎛️ Configurable parameters (temperature, top_p, etc.)
+- 🦙 Generate text using Ollama models
+- 🎛️ Configurable parameters (temperature, top_p, max_tokens)
 - 📊 Health monitoring
+- 🚀 Simple and lightweight API
 
 ## API Endpoints
 
 ### Health Check
-- `GET /health` - Check if the service is running
-- `GET /models` - List available models
+- `GET /health` - Check if Ollama service is running
+- `GET /` - API information and usage examples
 
-### Model Management
-- `POST /models/pull` - Pull a model from Ollama registry
-- `DELETE /models/{model_name}` - Delete a model
-
-### Chat & Completions
-- `POST /chat` - Chat with a model
+### Text Generation
 - `POST /generate` - Generate text completion
 
 ## Usage Examples
 
-### Pull a Model
+### Check Health
 ```bash
-curl -X POST "https://your-space.hf.space/models/pull" \
-  -H "Content-Type: application/json" \
-  -d '{"model": "llama2:7b"}'
-```
-
-### Chat with Model
-```bash
-curl -X POST "https://your-space.hf.space/chat" \
-  -H "Content-Type: application/json" \
-  -d '{
-    "model": "llama2:7b",
-    "messages": [
-      {"role": "user", "content": "Hello, how are you?"}
-    ]
-  }'
+curl "https://your-space.hf.space/health"
 ```
 
 ### Generate Text
@@ -60,35 +40,64 @@ curl -X POST "https://your-space.hf.space/chat" \
 curl -X POST "https://your-space.hf.space/generate" \
   -H "Content-Type: application/json" \
   -d '{
-    "model": "llama2:7b",
+    "model": "tinyllama",
     "prompt": "The future of AI is",
+    "temperature": 0.7,
     "max_tokens": 100
   }'
 ```
 
+### API Information
+```bash
+curl "https://your-space.hf.space/"
+```
+
+## Request Parameters
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `model` | string | required | Model name (e.g., "tinyllama") |
+| `prompt` | string | required | Input text prompt |
+| `temperature` | float | 0.7 | Sampling temperature (0.0-2.0) |
+| `top_p` | float | 0.9 | Top-p sampling (0.0-1.0) |
+| `max_tokens` | integer | 512 | Maximum tokens to generate (1-4096) |
+
 ## Supported Models
 
-This setup supports any model available in the Ollama registry:
-- `llama2:7b`, `llama2:13b`
-- `mistral:7b`
-- `codellama:7b`
-- `vicuna:7b`
-- And many more...
+This API works with any Ollama model. Recommended lightweight models for Hugging Face Spaces:
+
+- `tinyllama` - Very small and fast (~600MB)
+- `phi` - Small but capable (~1.6GB)
+- `llama2:7b` - Larger but more capable (~3.8GB)
 
 ## Interactive Documentation
 
-Once deployed, visit `/docs` for interactive API documentation.
+Once deployed, visit `/docs` for interactive API documentation powered by FastAPI.
+
+## Setup Notes
 
-## Notes
+- The startup script automatically pulls the `tinyllama` model
+- First generation may be slower as the model loads
+- Lightweight models are recommended for better performance on limited resources
 
-- Model pulling may take several minutes depending on model size
-- Larger models require more memory and may not work on free tier
-- First inference may be slower as the model loads into memory
+## Example Response
+
+```json
+{
+  "model": "tinyllama",
+  "response": "The future of AI is bright and full of possibilities...",
+  "done": true,
+  "total_duration": 1234567890,
+  "load_duration": 123456789,
+  "prompt_eval_count": 10,
+  "eval_count": 25
+}
+```
 
 ## Resource Requirements
 
-- **Small models (7B)**: 8GB+ RAM recommended
-- **Medium models (13B)**: 16GB+ RAM recommended  
-- **Large models (70B+)**: 32GB+ RAM required
+- **TinyLlama**: ~1GB RAM, very fast
+- **Phi models**: ~2GB RAM, good balance
+- **Llama2 7B**: ~8GB RAM, high quality
 
-Consider using smaller models like `llama2:7b` or `mistral:7b` for better performance on limited resources.
+For Hugging Face Spaces free tier, stick with TinyLlama or Phi models for best performance.