Welcome to the Prompt Analyzer Documentation
=============================================

.. figure:: /Documentation/images/pilot.jpg
   :width: 200
   :align: center
   :alt: Multi_RAG Documentation Cover

--------------------------------------------------------

.. figure:: /Documentation/images/app_screenshots.png
   :width: 600
   :align: center
   :alt: Application Screenshots
--------------------------------------------------------------




**Prompt Analyzer** is a cutting-edge tool designed to analyze, sort, and optimize prompts for natural language processing (NLP) tasks. Built on a robust architecture, it combines advanced metrics like **Semantic Vocabulary Richness**, **Relevance**, and **Lexical Density** with an intuitive user interface powered by **Streamlit**.

Key Features
------------

- **Multimodal Support**: Analyze and compare prompts in multiple ways.
- **Advanced Metrics**: Evaluate semantic and syntactic quality, relevance, and richness.
- **Customizable Analysis**: Flexible sorting and filtering options for tailored results.
- **Powerful Backend**: Leverages embeddings from `SentenceTransformer` models like `all-mpnet-base-v2`.

Audience
--------

This documentation is designed for researchers, developers, and NLP enthusiasts looking to enhance their workflows using Prompt Analyzer.

Next Steps
----------

Explore the following sections to get started:

- **Installation**: Learn how to set up Prompt Analyzer.
- **User Guide**: Step-by-step instructions for using the tool.
- **Advanced Features**: Dive into redundancy removal and hybrid relevance scoring.

.. toctree::
   :maxdepth: 2
   :caption: Introduction

   Documentation/scripts/Scope/introduction.rst

.. toctree::
   :maxdepth: 2
   :caption: Implementation

   Documentation/scripts/Scope/guide.rst

.. toctree::
   :maxdepth: 2
   :caption: Interface

   Documentation/scripts/Scope/interface.rst