atles / docs /guides /QUICK_START_GUIDE.md
spartan8806's picture
ATLES codebase - Source code only
99b8067

๐Ÿš€ ATLES Quick Start Guide

Get ATLES v0.5 + Phase 1 UI running in under 5 minutes!

๐ŸŽฏ What You'll Get

  • ๐Ÿค– AI Agents: Chat with Reasoning, Analysis, and Creative AI agents
  • ๐Ÿ”’ AI Safety: Built-in "Motherly Instinct" safety system
  • ๐Ÿ’ฌ Professional UI: Beautiful Streamlit chat interface
  • ๐Ÿ›ก๏ธ Real-time Monitoring: Live safety status and system health
  • ๐Ÿ’พ Persistent Memory: Conversations that remember context
  • ๐Ÿ“„ PDF Reading: Extract and analyze text from PDF documents
  • ๐Ÿงฉ Smart Dependencies: Graceful handling of optional packages

โšก Super Quick Start (Recommended)

Windows Users - One Click!

# Just double-click this file:
run_chat.bat

All Platforms - Smart Auto-Detection

python run_chat.py

That's it! The smart startup script will:

  • โœ… Detect your system setup
  • โœ… Install missing dependencies
  • โœ… Choose the best mode (full ATLES or demo)
  • โœ… Launch the beautiful chat interface

๐Ÿ”ง Manual Setup (If You Prefer)

Step 1: Install Dependencies

pip install -r streamlit_requirements.txt

Step 2: Choose Your Mode

Option A: Full ATLES Integration (Recommended)

pip install -r requirements.txt
streamlit run streamlit_chat.py

Option B: Demo Mode (Works Without Full ATLES)

streamlit run streamlit_chat_simple.py

๐ŸŽฎ Using ATLES - Your First Chat

1. Launch the Interface

  • Run one of the startup commands above
  • Your browser will open to the ATLES interface
  • You'll see the beautiful dark theme with ATLES branding

2. Initialize the Brain

  • Click "Initialize Brain" button (left panel)
  • Wait for the green "Brain: Active" status
  • This starts the AI system

3. Start Chatting

  • Click "Start Chat" button
  • Select your preferred AI agent:
    • ๐Ÿค– Reasoning: Complex problem-solving
    • ๐Ÿ“Š Analysis: Data analysis and patterns
    • ๐ŸŽจ Creative: Idea generation and creativity
  • Type your message in the chat box
  • Press Enter or click Send

4. Monitor Safety & Status

  • Left Panel: Safety system status and controls
  • Right Panel: Session details and system health
  • Real-time: Live safety monitoring with color indicators

๐ŸŽจ Interface Tour

Left Panel - Controls & Safety

  • ๐Ÿš€ Initialize Brain: Start the AI system
  • ๐Ÿ’ฌ Start Chat: Begin a new conversation
  • ๐Ÿค– AI Agent: Choose your AI companion
  • ๐Ÿ”„ Refresh Safety: Update safety status
  • ๐Ÿ”’ Safety Status: Real-time safety monitoring

Center Panel - Chat Area

  • ๐Ÿ’ฌ Chat History: Your conversation with ATLES
  • ๐Ÿ“ Input Field: Type your messages here
  • ๐Ÿ“ค Send Button: Send your message
  • โฐ Timestamps: When each message was sent

Right Panel - Session & Status

  • ๐Ÿ“Š Session: Active conversation details
  • โšก Actions: Refresh, clear chat, etc.
  • ๐Ÿ”ง Status: System health and brain status

๐Ÿ›ก๏ธ AI Safety Features

What's Protected

  • Physical Harm: Violence, weapons, dangerous activities
  • Emotional Harm: Self-harm, manipulation, bullying
  • Financial Harm: Scams, fraud, theft
  • Privacy Violation: Hacking, stalking, data theft
  • Illegal Activities: Crimes, illegal substances, fraud

How It Works

  • Real-time Monitoring: Every message is safety-checked
  • Gentle Redirection: Helpful alternatives instead of blocking
  • Professional Resources: Direct access to appropriate help
  • Visual Indicators: Color-coded safety status

๏ฟฝ Optional Features

PDF Reading Capability

To enable PDF reading functionality:

# Install required packages
pip install pdfplumber requests

# Or use the provided script (Windows)
install_pdf_support.bat

Using PDF Reading

Once installed, you can read PDFs from URLs:

User: Can you read this research paper? https://arxiv.org/pdf/2212.08073.pdf
ATLES: FUNCTION_CALL:read_pdf:{"url": "https://arxiv.org/pdf/2212.08073.pdf"}

Debug Mode

To enable debug mode for function calls:

# Show current status
toggle_debug.bat status

# Enable function call debugging
toggle_debug.bat function

๏ฟฝ๐Ÿ” Troubleshooting

Common Issues & Solutions

"ModuleNotFoundError: No module named 'atles'"

  • Solution: Use demo mode: streamlit run streamlit_chat_simple.py
  • Or: Install full ATLES: pip install -r requirements.txt

"Streamlit not found"

  • Solution: Install Streamlit: pip install streamlit

"Port already in use"

  • Solution: Change port: streamlit run streamlit_chat.py --server.port 8502

"Browser doesn't open automatically"

  • Solution: Manually open: http://localhost:8501

Getting Help

  • Check the console output for error messages
  • Verify all dependencies are installed
  • Try demo mode first to test the interface
  • Check the full documentation for advanced setup

๐Ÿš€ Advanced Usage

Customizing Your Experience

  • Agent Selection: Switch between agents mid-conversation
  • Session Management: Start new conversations or continue existing ones
  • Safety Monitoring: Keep an eye on system safety status
  • Performance: Monitor system health and responsiveness

Integration Options

  • Full ATLES: Complete AI agent system with safety
  • Demo Mode: Test the interface without full integration
  • Custom Setup: Modify for your specific needs

๐Ÿ“š Next Steps

Learn More

  • Full Documentation: Check ATLES_Project_Summary.md
  • API Reference: Explore the technical documentation
  • Examples: Try different types of conversations
  • Safety Features: Test the AI safety system

What's Coming Next

  • Phase 2: Full dashboard with advanced controls
  • Phase 3: Real-time monitoring and analytics
  • v0.6: Next major version planning

๐ŸŽ‰ Congratulations!

You're now running ATLES v0.5 + Phase 1 UI - a state-of-the-art AI system with:

  • โœ… Professional Interface: Beautiful, responsive Streamlit UI
  • โœ… AI Agents: Three specialized AI companions
  • โœ… Safety First: Comprehensive harm prevention
  • โœ… Real-time Monitoring: Live system status
  • โœ… Production Ready: Professional-grade implementation

Start chatting with your AI agents and explore the future of AI safety! ๐Ÿš€


๐Ÿ“ž Need Help?

  • Documentation: Check the project files
  • Issues: Look for error messages in the console
  • Community: Join ATLES discussions
  • Safety: Use the built-in safety reporting system

Happy AI chatting! ๐Ÿค–๐Ÿ’ฌ