Create README.md

README.md

@@ -0,0 +1,45 @@
+---
+library_name: transformers
+tags:
+- gpt2
+- transformers
+- text-generation
+- adventure
+- travel-itinerary
+- custom-model
+pipeline_tag: text-generation
+---
+
+# TripTuner: Adventure Travel Itinerary Generator for Central Province, Sri Lanka
+
+## Overview
+
+**TripTuner** is a custom-trained GPT-2 model designed to generate personalized adventure travel itineraries specifically for locations within the Central Province of Sri Lanka. The model is fine-tuned to provide detailed descriptions of adventure activities such as trekking, hiking, camping, and exploring scenic views, making it ideal for travel enthusiasts and tour planners.
+
+## Model Details
+
+- **Model Type**: GPT-2
+- **Library**: Transformers by Hugging Face
+- **Use Case**: Text generation focused on adventure travel itineraries
+- **Languages**: English
+- **Training Data**: The model was fine-tuned on a custom dataset of adventure activities in various locations within Sri Lanka's Central Province.
+
+## How to Use
+
+You can use this model directly with the Hugging Face Inference API or load it into your Python environment using the Transformers library.
+
+### Using the Inference API
+
+You can test the model directly via the Hugging Face platform by clicking on the "Inference API" tab.
+
+### Using Transformers Pipeline
+
+```python
+from transformers import pipeline
+
+# Load the text generation pipeline using the uploaded model from Hugging Face
+generator = pipeline('text-generation', model='yoonusajward01/triptuner')
+
+# Test the model with a prompt
+response = generator("[Q] Describe an adventure itinerary for Knuckles Mountain Range.", max_length=150, num_return_sequences=1)
+print(response[0]['generated_text'])