Skip to content

Commit 40c73fa

Browse files
authored
Merge pull request #1082 from Venkateeshh/main
Update README.md with latest enhancements, new models, use cases
2 parents 600f8d8 + fd5219b commit 40c73fa

File tree

1 file changed

+55
-15
lines changed

1 file changed

+55
-15
lines changed

README.md

+55-15
Original file line numberDiff line numberDiff line change
@@ -622,36 +622,76 @@ if __name__ == "__main__":
622622
```
623623
</details>
624624

625+
## 🔥 Latest Enhancements and Features 🔥
625626

626-
## 🔥 What's New? 🔥
627+
### Model Capabilities & Benchmarks
627628

628-
-**Benchmarking Small Model Capabilities** - see [benchmark results](https://medium.com/@darrenoberst/best-small-language-models-for-accuracy-and-enterprise-use-cases-benchmark-results-cf71964759c8) and [model_ranking example](fast_start/agents/agents-15-get_model_benchmarks.py)
629+
- **Benchmarking Small Model Capabilities**
630+
Explore the latest benchmark results for small language models focusing on accuracy and enterprise use cases.
631+
- [Read benchmark results](https://medium.com/@darrenoberst/best-small-language-models-for-accuracy-and-enterprise-use-cases-benchmark-results-cf71964759c8)
632+
- [Example code for model ranking](fast_start/agents/agents-15-get_model_benchmarks.py)
629633

630-
-**Using Qwen2 Models for RAG, Function Calling and Chat** - get started in minutes - see [example](https://github.com/llmware-ai/llmware/tree/main/examples/Models/using-qwen2-models.py)
634+
### New Models and Functionality
631635

632-
-**New Phi-3 Function Calling Models** - get started in minutes - see [example](https://github.com/llmware-ai/llmware/tree/main/examples/Models/using-phi-3-function-calls.py)
636+
- **Qwen2 Models for RAG, Function Calling, and Chat**
637+
Start using Qwen2 models quickly with resources for Retrieval-Augmented Generation (RAG), function calling, and chat functionalities.
638+
- [Quickstart example](https://github.com/llmware-ai/llmware/tree/main/examples/Models/using-qwen2-models.py)
633639

634-
-**BizBot - RAG + SQL Local Chatbot** - see [example](https://github.com/llmware-ai/llmware/tree/main/examples/Use_Cases/biz_bot.py) and [video](https://youtu.be/4nBYDEjxxTE?si=o6PDPbu0PVcT-tYd)
640+
- **Phi-3 Function Calling Models**
641+
Get started in minutes with Phi-3 models designed for function calling.
642+
- [Quickstart example](https://github.com/llmware-ai/llmware/tree/main/examples/Models/using-phi-3-function-calls.py)
635643

636-
**Lecture Tool Use Case - ask questions to a voice recording** - see [lecture_tool](https://github.com/llmware-ai/llmware/blob/main/examples/Use_Cases/lecture_tool/)
644+
### New Use Cases & Applications
637645

638-
-**Web Services with Agent Calls for Financial Research** - end-to-end scenario - [video](https://youtu.be/l0jzsg1_Ik0?si=hmLhpT1iv_rxpkHo) and [example](examples/Use_Cases/web_services_slim_fx.py)
646+
- **BizBot: RAG + SQL Local Chatbot**
647+
Implement a local chatbot for business intelligence using RAG and SQL.
648+
- [Code example](https://github.com/llmware-ai/llmware/tree/main/examples/Use_Cases/biz_bot.py) | [Demo video](https://youtu.be/4nBYDEjxxTE?si=o6PDPbu0PVcT-tYd)
639649

640-
-**Voice Transcription with WhisperCPP** - [getting_started](examples/Models/using-whisper-cpp-getting-started.py), [using_sample_files](examples/Models/using-whisper-cpp-sample-files.py), and [analysis_use_case](examples/Use_Cases/parsing_great_speeches.py) with [great_speeches_video](https://youtu.be/5y0ez5ZBpPE?si=KVxsXXtX5TzvlEws)
650+
- **Lecture Tool**
651+
Enables Q&A on voice recordings for education and lecture analysis.
652+
- [Lecture tool code](https://github.com/llmware-ai/llmware/blob/main/examples/Use_Cases/lecture_tool/)
641653

642-
-**Phi-3 GGUF Streaming Local Chatbot with UI** - setup your own Phi-3-gguf chatbot on your laptop in minutes - [example](examples/UI/gguf_streaming_chatbot.py) with [video](https://youtu.be/gzzEVK8p3VM?si=8cNn_do0oxSzCEnM)
654+
- **Web Services for Financial Research**
655+
An end-to-end example demonstrating web services with agent calls for financial research.
656+
- [Demo video](https://youtu.be/l0jzsg1_Ik0?si=hmLhpT1iv_rxpkHo) | [Code example](examples/Use_Cases/web_services_slim_fx.py)
643657

644-
-**Natural Language Query to CSV End to End example** - using the slim-sql model - [video](https://youtu.be/z48z5XOXJJg?si=V-CX1w-7KRioI4Bi) and [example](examples/SLIM-Agents/text2sql-end-to-end-2.py) and now using Custom Tables on Postgres [example](https://github.com/llmware-ai/llmware/tree/main/examples/Use_Cases/agent_with_custom_tables.py)
658+
### Audio & Text Processing
645659

646-
-**Multi-Model Agents with SLIM models** - multi-step Agents with SLIMs on CPU - [video](https://www.youtube.com/watch?v=cQfdaTcmBpY) - [example](examples/SLIM-Agents)
660+
- **Voice Transcription with WhisperCPP**
661+
Start transcription projects with WhisperCPP, featuring tools for sample file usage and famous speeches.
662+
- [Getting started guide](examples/Models/using-whisper-cpp-getting-started.py) | [Parsing great speeches](examples/Use_Cases/parsing_great_speeches.py) | [Demo video](https://youtu.be/5y0ez5ZBpPE?si=KVxsXXtX5TzvlEws)
647663

648-
-**OCR Embedded Document Images Example** - systematically extract text from images embedded in documents [example](examples/Parsing/ocr_embedded_doc_images.py)
664+
- **Natural Language Query to CSV**
665+
Convert natural language queries to CSV with Slim-SQL, supporting custom Postgres tables.
666+
- [Demo video](https://youtu.be/z48z5XOXJJg?si=V-CX1w-7KRioI4Bi) | [End-to-end example](examples/SLIM-Agents/text2sql-end-to-end-2.py) | [Custom table usage](https://github.com/llmware-ai/llmware/tree/main/examples/Use_Cases/agent_with_custom_tables.py)
649667

650-
-**Enhanced Parser Functions for PDF, Word, Powerpoint and Excel** - new text-chunking controls and strategies, extract tables, images, header text - [example](examples/Parsing/pdf_parser_new_configs.py)
668+
### Multi-Model Agents
669+
670+
- **Multi-Model Agents with SLIM**
671+
Use SLIM models on CPU for multi-step agents in complex workflows.
672+
- [Demo video](https://www.youtube.com/watch?v=cQfdaTcmBpY) | [Example directory](examples/SLIM-Agents)
673+
674+
### Document & OCR Processing
675+
676+
- **OCR Embedded Document Images**
677+
Extract text systematically from images embedded in documents for enhanced document processing.
678+
- [OCR example](examples/Parsing/ocr_embedded_doc_images.py)
679+
680+
- **Enhanced Document Parsing for PDFs, Word, PowerPoint, and Excel**
681+
Improved text-chunking controls, table extraction, and content parsing.
682+
- [Parsing example](examples/Parsing/pdf_parser_new_configs.py)
683+
684+
### Deployment & Optimization
685+
686+
- **Agent Inference Server**
687+
Set up an inference server for multi-model agents to optimize deployments.
688+
- [Server setup example](https://github.com/llmware-ai/llmware/tree/main/examples/SLIM-Agents/agent_api_endpoint.py)
689+
690+
- **Optimizing Accuracy of RAG Prompts**
691+
Tutorials for tuning RAG prompt settings for increased accuracy.
692+
- [Settings example](examples/Models/adjusting_sampling_settings.py) | Videos: [Part I](https://youtu.be/7oMTGhSKuNY?si=14mS2pftk7NoKQbC), [Part II](https://youtu.be/iXp1tj-pPjM?si=T4teUAISnSWgtThu)
651693

652-
-**Agent Inference Server** - set up multi-model Agents over Inference Server [example](https://github.com/llmware-ai/llmware/tree/main/examples/SLIM-Agents/agent_api_endpoint.py)
653694

654-
-**Optimizing Accuracy of RAG Prompts** - check out [example](examples/Models/adjusting_sampling_settings.py) and videos - [part I](https://youtu.be/7oMTGhSKuNY?si=14mS2pftk7NoKQbC) and [part II](https://youtu.be/iXp1tj-pPjM?si=T4teUAISnSWgtThu)
655695

656696
## 🌱 Getting Started
657697

0 commit comments

Comments
 (0)