ai-tutor-chatbot / README.md
Omar Solano
update README.md
ac6677d
|
raw
history blame
1.39 kB
metadata
title: AI Tutor Chatbot
emoji: πŸ§‘πŸ»β€πŸ«
colorFrom: gray
colorTo: pink
sdk: gradio
sdk_version: 4.31.3
app_file: scripts/gradio-ui.py
pinned: false

This repository contains the notebooks for the RAG course in notebooks.

A Gradio UI for an AI tutor chatbot is available in scripts/gradio-ui.py.

The Gradio demo is deployed on Hugging Face Spaces service at this URL: AI Tutor Chatbot on Hugging Face.

There is a GitHub action that automatically deploys the Gradio demo after pushing changes inside the scripts folder.

Installation (for Gradio UI)

  1. Create a new Python environment:

    python -m venv .venv
    

    This command creates a virtual environment named .venv.

  2. Activate the environment:

    For macOS and Linux:

    source .venv/bin/activate
    
  3. Install the dependencies:

    pip install -r requirements.txt
    

Usage (for Gradio UI)

  1. Set environment variables:

    Before running the application, you need to set up your OpenAI API key:

    export OPENAI_API_KEY=your_openai_api_key_here
    
  2. Run the application:

    python scripts/gradio-ui.py
    

    This command starts the Gradio interface for the AI Tutor chatbot.