Skip to content

UPGRADE_GUIDE.md

Latest commit

 

History

History
195 lines (155 loc) · 5.67 KB

UPGRADE_GUIDE.md

File metadata and controls

195 lines (155 loc) · 5.67 KB

🚀 Upgrade Guide: FableForge AI 1.0 → 2.0

Welcome to FableForge AI 2.0! This guide will help you upgrade from the previous version with all the new features and improvements.

📋 What's New in Version 2.0

✨ Major Improvements

  • 🎨 Modern UI: Complete redesign with gradient styling and responsive layout
  • 🤖 Latest AI Models: Gemini 2.0 Flash and 2.5 Pro integration
  • 📊 Analytics Dashboard: Real-time metrics and usage insights
  • 🎯 AI Assistant Hub: Writing assistance, translation, and more
  • 🌊 Streaming Responses: Real-time text generation
  • 🔊 Enhanced Audio: Better text-to-speech with multiple voices
  • 📱 Mobile Responsive: Optimized for all device sizes

🆕 New Features

  • Navigation Pills: Modern tab-based navigation
  • Voice Input: Microphone integration (coming soon)
  • Download Options: Export stories and chat history
  • Model Selection: Choose from multiple AI models
  • Creative Writing: Poems, lyrics, character descriptions
  • Advanced Settings: Temperature and token controls

🔄 Migration Steps

1. Backup Your Current Setup

# Create a backup of your current installation
cp -r FableForgeAI-StoryEngine FableForgeAI-StoryEngine-backup

2. Update Dependencies

# Update to the latest packages
pip install --upgrade -r requirements.txt

3. Environment Variables

No changes needed! Your existing .env file will work perfectly:

GOOGLE_API_KEY=your_existing_key
HUGGING_FACE_AUTH_TOKEN=your_existing_token

4. New Dependencies Added

The following packages were added in v2.0:

  • plotly>=5.22.0 - For interactive charts
  • numpy>=1.24.0 - For data processing
  • pandas>=2.0.0 - For analytics
  • streamlit-audio-recorder>=0.0.8 - For voice input
  • streamlit-camera-input-live>=0.2.0 - For camera features

5. Updated Package Versions

  • streamlit>=1.45.0 (was unspecified)
  • google-generativeai>=0.8.5 (was gradio_client)
  • python-dotenv>=1.0.0 (was unspecified)
  • Pillow>=10.0.0 (was unspecified)

🆚 Feature Comparison

Feature v1.0 v2.0
UI Design Basic Modern gradient styling
AI Models Gemini Pro Gemini 2.0 Flash + 2.5 Pro
Navigation Simple menu Enhanced option menu
Story Generation Basic Multiple modes + genres
Audio Basic TTS Enhanced with options
Analytics ❌ ✅ Full dashboard
AI Assistant ❌ ✅ Multiple assistants
Streaming ❌ ✅ Real-time responses
Downloads ❌ ✅ Export options
Mobile Limited Fully responsive

🔧 Breaking Changes

⚠️ Important Notes

  1. No breaking changes in core functionality
  2. API keys remain the same - no need to regenerate
  3. All existing features preserved and enhanced
  4. Backward compatibility maintained

📝 Code Changes

If you've customized the code, here are the main changes:

Model Loading (Optional Update)

# Old way (still works)
model = genai.GenerativeModel("gemini-pro")

# New way (recommended)
model = load_gemini_pro_model()  # Auto-selects best available model

New Function Available

# Streaming responses (new feature)
response = gemini_stream_response(prompt)
for chunk in response:
    print(chunk.text)

🚀 New Features Guide

📊 Analytics Dashboard

Access via the sidebar navigation:

  • View usage statistics
  • Interactive charts with Plotly
  • Performance monitoring
  • User engagement metrics

🎯 AI Assistant Hub

Multiple assistant types:

  • Writing Assistant: Grammar, tone, translation
  • Research Helper: Information gathering
  • Idea Generator: Creative prompts
  • Learning Tutor: Educational content

🎨 Enhanced Story Generation

New story modes:

  • Image + Text: Upload images for inspiration
  • Text-Only: Pure text-based stories
  • Creative Writing: Poems, lyrics, descriptions

🌊 Streaming Responses

Enable in ChatBot settings:

  • Real-time text generation
  • Live typing effect
  • Better user experience

🔊 Improved Audio

New audio features:

  • Multiple voice options
  • Better quality TTS
  • Error handling
  • Format options (WAV, OGG)

🛠️ Troubleshooting

Common Upgrade Issues

  1. Package Conflicts

    pip uninstall streamlit
pip install streamlit>=1.45.0

  2. Missing Dependencies

    pip install plotly pandas numpy

  3. Audio Issues

    # Check Hugging Face token
echo $HUGGING_FACE_AUTH_TOKEN

  4. UI Not Loading

    # Clear Streamlit cache
streamlit cache clear

Performance Optimization

  1. Memory Usage

    • Use faster models for simple tasks
    • Enable caching in settings
    • Close unused browser tabs

  2. Response Speed

    • Select appropriate model
    • Adjust token limits
    • Use streaming for long responses

📞 Support

If you encounter any issues during the upgrade:

  1. Check the logs: Look for error messages in the terminal
  2. Verify API keys: Ensure they're valid and have correct permissions
  3. Update packages: Make sure all dependencies are latest versions
  4. Create an issue: GitHub Issues

🎉 Welcome to FableForge AI 2.0!

You're now ready to enjoy all the new features and improvements. Here's what to try first:

  1. 🎨 Explore the new UI - Check out the modern design
  2. 📊 Visit Analytics - See your usage patterns
  3. 🎯 Try AI Assistant - Get writing help
  4. 🌊 Enable Streaming - Experience real-time responses
  5. 🔊 Generate Audio - Listen to your stories

Happy storytelling! 🚀