Git Product home page Git Product logo

guided_rubric_1's Introduction

Interactive Article Review Assistant

This application leverages OpenAI's GPT models to guide users through a critical analysis of assets, like a scholarly journal articles. It prompts users with questions about an article, provides feedback on their responses, and scores their understanding based on a predefined rubric.

Key Features

  • Interactive Q&A: Engages users with a series of questions created by the educator.
  • AI-Powered Feedback: Utilizes OpenAI's GPT-4 to generate immediate, constructive feedback on user responses.
  • Rubric-Based Scoring: Evaluates user responses against a custom rubric to ensure a thorough analysis of the article.
  • Progress Tracking: Dynamically tracks user progress through the questions and feedback loops.
  • Visual and Animated Feedback: Incorporates Lottie animations and images to enhance user engagement and provide visual cues for feedback.

Setup and Installation

  1. Clone the Repository: Start by cloning this repository to your local machine.

  2. Install Dependencies: Install the required Python packages using pip:

    pip install -r requirements.txt
  3. Configure OpenAI API Key:

    • Create a .env file in the root directory of your project.
    • Add your OpenAI API key to the .env file:
      OPENAI_API_KEY='your_api_key_here'
      
  4. Run the Application: Navigate to the directory containing the application and run it using Streamlit:

    streamlit run main.py

Using the Application

  • Start the Application: After launching, the app will guide you to input your responses to a series of questions based on a specified article.
  • View PDF: A link to the target article PDF is provided within the app for reference.
  • Answer Questions: Type your answers directly into the input fields. The app will provide feedback and a score based on your responses.
  • Progress Through the Review: Your progress is saved as you move through the questions. You can skip questions.

Contribution and Support

  • Contribute: Contributions to improve the application or extend its capabilities are welcome! Please submit pull requests or open issues for bugs and feature requests.
  • Support: If you encounter any problems or have suggestions, please open an issue in the repository.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

guided_rubric_1's People

Contributors

jswope00 avatar

Watchers

 avatar

guided_rubric_1's Issues

Compare this with a RAG version

Hi Raja,
I'd like to be able to compare this app with a RAG version of the app which uses the local vector storage like your RAG example app.

The user experience should be from this app (students responds to questions, gets answers and feedback from the AI which has understanding of the shared doc), but the retrieval should be via local RAG rather than the Assistant with File_search. I'd like to be able to compare both, so perhaps duplicating this repo to create another app is best strategy.

John

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.