updates readme file

README.md

@@ -9,72 +9,95 @@ app_file: app.py
 pinned: false
 short_description: Multi Agent crew for Market Analysis and Use Case Generation
 ---
+
 # Market Research & Use Case Generation Agent
+
 ## Project Overview
-### Objective: 
+
+### Objective:
+
 Deploy Multi-Agent crew for Market Analysis and Use case Generator using Streamlit to provide an easy-to-use interface for model interaction.
-### Technology: 
+
+### Technology:
+
 - Streamlit, an open-source Python library for building custom web applications for machine learning and data science.
 - CrewAI, an open-source library for building ai agents
 
-### Model: 
-#### LLMS 
+### Model:
+
+#### LLMS
+
 - Uses gemini 1.5 flash version 002 as the base llm as it has the highest free token available to use while being fast and reliable when compared to other LLMs such as OpenAI, Anthropic etc
 - The model leverage the LiteLLM module as the backend for the LLM module in crewAI
 
 #### Crew
+
 The crew consists of 3 agents
-- Researcher: 
-    - Performs Market and Segment of the company
-    - Identifies the Key offering in comparison to the competition in the same segment 
-    - Provides the strategic focus of the company
-
-    > Tools: search_tool, web_search_tool, pdf_search_tool
-- Design Thinker 
-    - Analyzes the industry trends in the AI Space such as genai , llms etc using the information provided by the Researcher 
-    - Details some possible ideas using the mantra “Yes and …” while specifying the use cases, drawbacks and MVPs (Most Viable Product) to test the ideas
-    - The agent empathises with shareholders, focusing on how these ideas may impact and benefit customers.
-    
-    > Tools: search_tool, web_search_tool, pdf_search_tool
-
-- Developer 
-    - Takes two projects(can be increased) and finds information such as datasets, research papers, similar projects etc
-    - Gives suggestions on how this project can be modified for the company
-    
-    > Tools*: search_tool, web_search_tool, pdf_search_tool
-  
+
+- Researcher:
+
+  - Performs Market and Segment of the company
+  - Identifies the Key offering in comparison to the competition in the same segment
+  - Provides the strategic focus of the company
+
+  > Tools: search_tool, web_search_tool, pdf_search_tool
+
+- Design Thinker
+
+  - Analyzes the industry trends in the AI Space such as genai , llms etc using the information provided by the Researcher
+  - Details some possible ideas using the mantra “Yes and …” while specifying the use cases, drawbacks and MVPs (Most Viable Product) to test the ideas
+  - The agent empathises with shareholders, focusing on how these ideas may impact and benefit customers.
+
+  > Tools: search_tool, web_search_tool, pdf_search_tool
+
+- Developer
+  - Takes two projects(can be increased) and finds information such as datasets, research papers, similar projects etc
+  - Gives suggestions on how this project can be modified for the company
+  > Tools\*: search_tool, web_search_tool, pdf_search_tool
+
 > NOTE: These results are a cause of publicly available information as it does not have information about the internal documents of the company
+
 ### Tools
-There are 3 primary tools used 
+
+There are 3 primary tools used
+
 - [SerperDev](https://serper.dev/) to search the internet for relevant source materials
 - [WebsiteSearchTool](https://docs.crewai.com/tools/websitesearchtool) to perform RAG search within the content of a website
 - [PDF RAG](https://docs.crewai.com/tools/pdfsearchtool) Search to perform RAG search within PDF files sourced from the internet
 
 ## Implementation
+
 ### Streamlit Application Development
+
 **User Interface Design**: The Streamlit application was designed with a focus on user-friendliness and clarity. Key features include:
-- Input fields to input Serper API and Gemini API Keys 
+
+- Input fields to input Serper API and Gemini API Keys
 - Input fields for user queries or data.
 - Output display area for model responses or generated results.
-- Ability to download outputs generated by each agent separately 
+- Ability to download outputs generated by each agent separately
 
 ### Intuitive navigation and controls.
+
 **CrewAI Integration**: The CrewAI model was seamlessly integrated into the Streamlit application.
 
 **Customization**: The application was customized to align with the specific requirements of the CrewAI model and its intended use cases.
 
 ## Deployment
+
 **Local Deployment**: The Streamlit application was initially deployed locally for testing and development purposes.
 
 **Cloud Deployment: (Optional)** The application was later deployed to a cloud platform Hugging Face for accessibility over the internet
 
 ## Conclusion
+
 This project successfully demonstrated the effective deployment of CrewAI using Streamlit. The resulting application provides a user-friendly and accessible interface for interacting with the model, making it easier for users to leverage its capabilities.
 
 ## Future Work
+
 **Enhanced Features**: Additional features could be added to the application, such as ability to choose LLM models, or integration of other tools.
 
 **Model Updates**: Providing an input field for users to customize the output or the task of each agent
 
 # High Level Design
-[![](https://mermaid.ink/img/pako:eNptkk2LwjAQhv_KEPCmgvXWw4JWhIVdWNbuqRUZm-kHtklJUkqx_vdNW5V23Tm9mWcy84bMlUWSE3NZnMs6SlEZ8HehABuzGfxoUvAuDKkYI4IPbEgNcBNgWS7L5giLxVt7IME1RLIoUTTzhzjVdNaZoRa2QaSo7sqH29v-1jeZSgkNpZIRaU0cOBpsYXMf0Rd5itCQhjVwWYtcIsdzThBnOekWdsFunN13WTvj-YCvoXUmkrH5fjx4qwATEkYvGyzy4wQ5gUF9eQX-KtCEKkpPRspcT5kT2AefRnyK10HJ4z_4adSTIs6SSqHJpIC9zPnDrK7OicIyvZdMWBfeaqSdQdvvGPX2O6v_93xFXfijlr4z0utRezZnBakCM26359qBkJmUCgqZayVHdQlZKG62DisjD42ImGtURXOmZJWkj0NV2l-nXYbWUcHcGHNts8QzI9XnsJv9it5-AbXs15o?type=png)](https://mermaid.live/edit#pako:eNptkk2LwjAQhv_KEPCmgvXWw4JWhIVdWNbuqRUZm-kHtklJUkqx_vdNW5V23Tm9mWcy84bMlUWSE3NZnMs6SlEZ8HehABuzGfxoUvAuDKkYI4IPbEgNcBNgWS7L5giLxVt7IME1RLIoUTTzhzjVdNaZoRa2QaSo7sqH29v-1jeZSgkNpZIRaU0cOBpsYXMf0Rd5itCQhjVwWYtcIsdzThBnOekWdsFunN13WTvj-YCvoXUmkrH5fjx4qwATEkYvGyzy4wQ5gUF9eQX-KtCEKkpPRspcT5kT2AefRnyK10HJ4z_4adSTIs6SSqHJpIC9zPnDrK7OicIyvZdMWBfeaqSdQdvvGPX2O6v_93xFXfijlr4z0utRezZnBakCM26359qBkJmUCgqZayVHdQlZKG62DisjD42ImGtURXOmZJWkj0NV2l-nXYbWUcHcGHNts8QzI9XnsJv9it5-AbXs15o)
+
+[![](https://mermaid.ink/img/pako:eNptkk2LwjAQhv_KEPCmgvXWw4JWhIVdWNbuqRUZm-kHtklJUkqx_vdNW5V23Tm9mWcy84bMlUWSE3NZnMs6SlEZ8HehABuzGfxoUvAuDKkYI4IPbEgNcBNgWS7L5giLxVt7IME1RLIoUTTzhzjVdNaZoRa2QaSo7sqH29v-1jeZSgkNpZIRaU0cOBpsYXMf0Rd5itCQhjVwWYtcIsdzThBnOekWdsFunN13WTvj-YCvoXUmkrH5fjx4qwATEkYvGyzy4wQ5gUF9eQX-KtCEKkpPRspcT5kT2AefRnyK10HJ4z_4adSTIs6SSqHJpIC9zPnDrK7OicIyvZdMWBfeaqSdQdvvGPX2O6v_93xFXfijlr4z0utRezZnBakCM26359qBkJmUCgqZayVHdQlZKG62DisjD42ImGtURXOmZJWkj0NV2l-nXYbWUcHcGHNts8QzI9XnsJv9it5-AbXs15o?type=png)](https://mermaid.live/edit#pako:eNptkk2LwjAQhv_KEPCmgvXWw4JWhIVdWNbuqRUZm-kHtklJUkqx_vdNW5V23Tm9mWcy84bMlUWSE3NZnMs6SlEZ8HehABuzGfxoUvAuDKkYI4IPbEgNcBNgWS7L5giLxVt7IME1RLIoUTTzhzjVdNaZoRa2QaSo7sqH29v-1jeZSgkNpZIRaU0cOBpsYXMf0Rd5itCQhjVwWYtcIsdzThBnOekWdsFunN13WTvj-YCvoXUmkrH5fjx4qwATEkYvGyzy4wQ5gUF9eQX-KtCEKkpPRspcT5kT2AefRnyK10HJ4z_4adSTIs6SSqHJpIC9zPnDrK7OicIyvZdMWBfeaqSdQdvvGPX2O6v_93xFXfijlr4z0utRezZnBakCM26359qBkJmUCgqZayVHdQlZKG62DisjD42ImGtURXOmZJWkj0NV2l-nXYbWUcHcGHNts8QzI9XnsJv9it5-AbXs15o)