gschatbot_2 / README.md
songhune's picture
Update README.md
fe42b90 verified

A newer version of the Gradio SDK is available: 5.13.1

Upgrade
metadata
title: Gschatbot 2
emoji: ๐Ÿ’ฌ
colorFrom: yellow
colorTo: purple
sdk: gradio
sdk_version: 4.36.1
app_file: app.py
pinned: false
license: unknown

Gaslighting Chatbot

Description

๊ฐ€์Šค๋ผ์ดํŒ… ์ฑ—๋ด‡ ํ”„๋กœ์ ํŠธ

Prerequisites

  • Python 3.7 or higher
  • pip (Python package installer)

Setup Instructions

  1. Clone the repository:

    git clone <repository_url>
    cd <repository_directory>
    
  2. Create a virtual environment (optional but recommended):

    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
    
  3. Install the required packages:

    pip install -r requirements.txt
    
  4. Create a .env file in the project root directory and add your OpenAI API key:

    OPENAI_API_KEY=sk-YourOpenAIKeyHere
    

    ๋ณ„๋„์˜ openai api๋ฅผ ํ•„์š”๋กœ ํ•ฉ๋‹ˆ๋‹ค.

  5. Add .env to .gitignore to ensure it is not tracked by git:

    # .gitignore
    .env
    
  6. Run the chatbot: HICํด๋” ๋‚ด๋ถ€์˜ V1~Vx๊นŒ์ง€ ๊ฐ€๋Šฅ

File Descriptions

  • chatbot.py: The main script to run the chatbot.
  • requirements.txt: Lists the dependencies required for the project.
  • .env: File to store environment variables (e.g., API keys). Do not commit this file to version control.
  • .gitignore: Ensures .env and other files are not tracked by git.
  • README.md: This readme file.