Skip to content

Latest commit

 

History

History
131 lines (98 loc) · 7.64 KB

README.md

File metadata and controls

131 lines (98 loc) · 7.64 KB
Raw

project-logo

PROMPT-LOGGING-SYSTEM-FRONTEND

Unleash real-time insights through interactive visualization.

last-commit repo-top-language repo-language-count


Table of Contents

Overview

Prompt-Logging-System-fe, a web application built with Streamlit, provides real-time data visualization and interactive querying capabilities. Users can select model types and environments to retrieve dynamic responses from a backend API, enhancing interactivity and visualization within the Prompt Logging System architecture. The project offers a Dashboard for filtering and visualizing user data, and a Metrics page for real-time metric retrieval and display. Its value lies in empowering users to explore and interact with data visually, improving data analysis efficiency and decision-making processes within the logging system.

Features

Feature Description
⚙️ Architecture Based on the provided details, the project seems to be structured around a Streamlit app that facilitates querying an API to generate responses based on user prompts. It enhances interactivity and real-time response visualization within the Prompt Logging System architecture.
📄 Documentation The project includes a requirements.txt file, which lists the dependencies for the Prompt Logging System. This ensures the availability of essential libraries for project functionality. Further documentation on code structure, usage, and contribution guidelines would enhance the overall documentation quality.
🔌 Integrations Key integrations and external dependencies include Pygments, plotly, pydeck, watchdog, Streamlit, GitPython, pandas, and more. These integrations enhance the project's capability to interact with APIs, visualize data, and manage dependencies effectively.
🧩 Modularity The project exhibits modularity by separating functionalities into different modules such as prompt.py, Dashboard.py, and Metrics.py. This design approach promotes code reusability and maintainability.
📦 Dependencies Key external libraries and dependencies include Pygments, plotly, pandas, Streamlit, GitPython, and more. Managing dependencies effectively is crucial for ensuring project functionality and stability.

Repository Structure

└── Prompt-Logging-System-fe/
    ├── README.md
    ├── pages
    │   ├── Dashboard.py
    │   └── Metrics.py
    ├── prompt.py
    └── requirements.txt

Modules

Home
File Summary
prompt.py Facilitates querying an API to generate responses based on user prompts in a Streamlit app. Features user input selection for model type and environment, enabling dynamic data retrieval and display. Enhances interactivity and real-time response visualization within the Prompt Logging System architecture.
requirements.txt Requirements file lists dependencies for the Prompt Logging System.-Ensures availability of essential libraries for project functionality.
Pages
File Summary
Dashboard.py Generates data visualizations with filtering options from a backend API using Streamlit. Displays unique user data and allows time frame, environment, model, status, and user filtering. Visualizes the data in a table format on a web dashboard for user interaction.
Metrics.py Retrieves and displays metrics data dynamically from a backend API. Users can filter metrics by time range, environment, model, status, and user. The dashboard includes total input and output tokens, a real-time Requests per Second plot, and various interactive filtering options.

Getting Started

System Requirements:

  • Python: version 3.10

Installation

From source

  1. Clone the Prompt-Logging-System-fe repository:
$ git clone https://github.com/kashishvjain/Prompt-Logging-System-fe
  1. Change to the project directory:
$ cd Prompt-Logging-System-fe
  1. Install the dependencies:
$ pip install -r requirements.txt

Usage

From source

Run Prompt-Logging-System-fe using the command below:

$ python main.py