From 852bd0de0bf04d71b714061714b37af5183e3f6a Mon Sep 17 00:00:00 2001 From: Prerak Jain Date: Fri, 4 Oct 2024 00:36:11 +0530 Subject: [PATCH 1/2] [Rerank-Doc] : Added root level rerank microservices documentation --- comps/reranks/README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 comps/reranks/README.md diff --git a/comps/reranks/README.md b/comps/reranks/README.md new file mode 100644 index 000000000..d92f27dd3 --- /dev/null +++ b/comps/reranks/README.md @@ -0,0 +1,32 @@ +# ReRank Microservice + +## Introduction +Provides functionality for reranking outputs. +It allows for fine-tuning the results based on specific criteria, improving the overall quality and relevance for the user. + +## Key Features +- **Configurable Ranking Criteria**: Define custom ranking rules based on various factors like relevance, creativity, style, or user-defined metrics. +- **Multiple Ranking Models**: Integrate with different ranking models, enabling flexibility in selection based on the desired outcome and data type. +- **Real-time Reranking**: Rerank outputs in real-time, ensuring the best possible results are presented to the user with minimal latency. +- **Performance Monitoring**: Monitor the performance of the reranking process, including processing time and effectiveness of applied rules. +- **Scalability**: Designed to handle large-scale workloads and support increasing volumes of generated outputs. +- **Integration with Other Services**: Seamless integration with other microservices in the application for a smooth data flow and overall processing pipeline. + +## Additional Notes +- This document provides a high-level overview of the Reranking Microservice. +- For detailed information on configuration, available ranking models, and API documentation, please refer to the dedicated service specifications. +- This microservice can be customized to specific application needs through configuration and integration with external tools. + +## Users are able to configure and build reranking-related services according to their actual needs. + +### Reranking Microservice with TEI +For details, please refer to [readme](tei/README.md). + +### Reranking Microservice with Mosec +For details, please refer to this [readme](mosec/langchain/README.md). + +### Reranking Microservice with FastRAG +For details, please refer to this [readme](fastrag/README.md). + +### Reranking Microservice with VideoQnA +For details, please refer to this [readme](videoqna/README.md). From 776e9ce218b2a5a7ec45659d9c52ccdd758da41b Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 3 Oct 2024 19:08:13 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- comps/reranks/README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/comps/reranks/README.md b/comps/reranks/README.md index d92f27dd3..c51db0793 100644 --- a/comps/reranks/README.md +++ b/comps/reranks/README.md @@ -1,10 +1,12 @@ # ReRank Microservice ## Introduction -Provides functionality for reranking outputs. + +Provides functionality for reranking outputs. It allows for fine-tuning the results based on specific criteria, improving the overall quality and relevance for the user. ## Key Features + - **Configurable Ranking Criteria**: Define custom ranking rules based on various factors like relevance, creativity, style, or user-defined metrics. - **Multiple Ranking Models**: Integrate with different ranking models, enabling flexibility in selection based on the desired outcome and data type. - **Real-time Reranking**: Rerank outputs in real-time, ensuring the best possible results are presented to the user with minimal latency. @@ -13,6 +15,7 @@ It allows for fine-tuning the results based on specific criteria, improving the - **Integration with Other Services**: Seamless integration with other microservices in the application for a smooth data flow and overall processing pipeline. ## Additional Notes + - This document provides a high-level overview of the Reranking Microservice. - For detailed information on configuration, available ranking models, and API documentation, please refer to the dedicated service specifications. - This microservice can be customized to specific application needs through configuration and integration with external tools. @@ -20,13 +23,17 @@ It allows for fine-tuning the results based on specific criteria, improving the ## Users are able to configure and build reranking-related services according to their actual needs. ### Reranking Microservice with TEI + For details, please refer to [readme](tei/README.md). ### Reranking Microservice with Mosec + For details, please refer to this [readme](mosec/langchain/README.md). ### Reranking Microservice with FastRAG + For details, please refer to this [readme](fastrag/README.md). ### Reranking Microservice with VideoQnA + For details, please refer to this [readme](videoqna/README.md).