mirror of
				https://github.com/microsoft/autogen.git
				synced 2025-10-31 01:40:58 +00:00 
			
		
		
		
	Fix format and links in documentations (#310)
* Fix format and links * Update title * Sync title * Add examples to installation
This commit is contained in:
		
							parent
							
								
									e20ecfd259
								
							
						
					
					
						commit
						a456b512d5
					
				| @ -48,6 +48,7 @@ The conversation terminates if no more documents are available for the context. | ||||
| 
 | ||||
| ## Basic Usage of RAG Agents | ||||
| 0. Install dependencies | ||||
| 
 | ||||
| Please install pyautogen with the [retrievechat] option before using RAG agents. | ||||
| ```bash | ||||
| pip install "pyautogen[retrievechat]" | ||||
| @ -471,5 +472,5 @@ The online app and the source code are hosted in [HuggingFace](https://huggingfa | ||||
| 
 | ||||
| ## Read More | ||||
| You can check out more example notebooks for RAG use cases: | ||||
| - [Auto Generated Agent Chat: Using RetrieveChat for Retrieve Augmented Code Generation and Question Answering](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_RetrieveChat.ipynb) | ||||
| - [Auto Generated Agent Chat: Group Chat with Retrieval Augmented Generation](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_groupchat_RAG.ipynb) | ||||
| - [Automated Code Generation and Question Answering with Retrieval Augmented Agents](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_RetrieveChat.ipynb) | ||||
| - [Group Chat with Retrieval Augmented Generation (with 5 group member agents and 1 manager agent)](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_groupchat_RAG.ipynb) | ||||
|  | ||||
| @ -17,3 +17,4 @@ Links to notebook examples: | ||||
| * [Automated Continual Learning from New Data](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_stream.ipynb) | ||||
| * [Teach Agents New Skills & Reuse via Automated Chat](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_teaching.ipynb) | ||||
| * [Automated Code Generation and Question Answering with Retrieval Augemented Agents](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_RetrieveChat.ipynb) | ||||
| * [Group Chat with Retrieval Augmented Generation (with 5 group member agents and 1 manager agent)](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_groupchat_RAG.ipynb) | ||||
|  | ||||
| @ -43,19 +43,33 @@ pip install docker | ||||
| ``` | ||||
| 
 | ||||
| * blendsearch | ||||
| 
 | ||||
| AutoGen offers a cost-effective hyperparameter optimization technique [EcoOptiGen](https://arxiv.org/abs/2303.04673) for tuning Large Language Models. Please install with the [blendsearch] option to use it. | ||||
| ```bash | ||||
| pip install "pyautogen[blendsearch]" | ||||
| ``` | ||||
| 
 | ||||
| Example notebooks: | ||||
| [Optimize for Code Generation](https://github.com/microsoft/autogen/blob/main/notebook/oai_completion.ipynb), | ||||
| [Optimize for Math](https://github.com/microsoft/autogen/blob/main/notebook/oai_chatgpt_gpt4.ipynb) | ||||
| 
 | ||||
| * retrievechat | ||||
| 
 | ||||
| AutoGen supports retrieval-augmented generation tasks such as question answering and code generation with RAG agents. Please install with the [retrievechat] option to use it. | ||||
| ```bash | ||||
| pip install "pyautogen[retrievechat]" | ||||
| ``` | ||||
| 
 | ||||
| Example notebooks: | ||||
| [Automated Code Generation and Question Answering with Retrieval Augmented Agents](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_RetrieveChat.ipynb), | ||||
| [Group Chat with Retrieval Augmented Generation (with 5 group member agents and 1 manager agent)](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_groupchat_RAG.ipynb) | ||||
| 
 | ||||
| * mathchat | ||||
| 
 | ||||
| AutoGen offers an experimental agent for math problem solving. Please install with the [mathchat] option to use it. | ||||
| ```bash | ||||
| pip install "pyautogen[mathchat]" | ||||
| ``` | ||||
| 
 | ||||
| Example notebooks: | ||||
| [Using MathChat to Solve Math Problems](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_MathChat.ipynb) | ||||
|  | ||||
| @ -105,11 +105,11 @@ The figure below shows six examples of applications built using AutoGen. | ||||
|    - **Web Search**: Solve Tasks Requiring Web Info - [View Notebook](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_web_info.ipynb) | ||||
|    - Use Provided Tools as Functions - [View Notebook](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_function_call.ipynb) | ||||
|    - Task Solving with Langchain Provided Tools as Functions - [View Notebook](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_function_call.ipynb) | ||||
|    - **RAG**: Group Chat with Retrieval Augmented Generation - [View Notebook](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_groupchat_RAG.ipynb) | ||||
|    - In-depth Guide to OpenAI Utility Functions - [View Notebook](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_groupchat_RAG.ipynb) | ||||
|    - **RAG**: Group Chat with Retrieval Augmented Generation (with 5 group member agents and 1 manager agent) - [View Notebook](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_groupchat_RAG.ipynb) | ||||
|    - In-depth Guide to OpenAI Utility Functions - [View Notebook](https://github.com/microsoft/autogen/blob/main/notebook/oai_openai_utils.ipynb) | ||||
| 
 | ||||
| 5. **Agent Teaching and Learning** | ||||
|    - Teach Agents New Skills & Reuse via Automated Chat - [View Notebook](https://github.com/microsoft/autogen/blob/main/notebook/oai_openai_utils.ipynb) | ||||
|    - Teach Agents New Skills & Reuse via Automated Chat - [View Notebook](https://github.com/microsoft/autogen/blob/main/notebook/agentchat_teaching.ipynb) | ||||
| 
 | ||||
| ## For Further Reading | ||||
| 
 | ||||
|  | ||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user
	 Li Jiang
						Li Jiang