autogen/website/docs/installation/Optional-Dependencies.md
Jack Gerrits 9434cd4c20
docs: split apart installation docs into parts (#1420)
* docs: split apart installation file into parts

* missing newline

* fix link

---------

Co-authored-by: Chi Wang <wang.chi@microsoft.com>
2024-01-27 19:03:24 +00:00

3.9 KiB

Optional Dependencies

LLM Caching

To use LLM caching with Redis, you need to install the Python package with the option redis:

pip install "pyautogen[redis]"

See LLM Caching for details.

Docker

Even if you install AutoGen locally, we highly recommend using Docker for code execution.

To use docker for code execution, you also need to install the python package docker:

pip install docker

You might want to override the default docker image used for code execution. To do that set use_docker key of code_execution_config property to the name of the image. E.g.:

user_proxy = autogen.UserProxyAgent(
    name="agent",
    human_input_mode="TERMINATE",
    max_consecutive_auto_reply=10,
    code_execution_config={"work_dir":"_output", "use_docker":"python:3"},
    llm_config=llm_config,
    system_message=""""Reply TERMINATE if the task has been solved at full satisfaction.
Otherwise, reply CONTINUE, or the reason why the task is not solved yet."""
)

blendsearch

pyautogen<0.2 offers a cost-effective hyperparameter optimization technique EcoOptiGen for tuning Large Language Models. Please install with the [blendsearch] option to use it.

pip install "pyautogen[blendsearch]<0.2"

Example notebooks:

Optimize for Code Generation

Optimize for Math

retrievechat

pyautogen supports retrieval-augmented generation tasks such as question answering and code generation with RAG agents. Please install with the [retrievechat] option to use it.

pip install "pyautogen[retrievechat]"

RetrieveChat can handle various types of documents. By default, it can process plain text and PDF files, including formats such as 'txt', 'json', 'csv', 'tsv', 'md', 'html', 'htm', 'rtf', 'rst', 'jsonl', 'log', 'xml', 'yaml', 'yml' and 'pdf'. If you install unstructured (pip install "unstructured[all-docs]"), additional document types such as 'docx', 'doc', 'odt', 'pptx', 'ppt', 'xlsx', 'eml', 'msg', 'epub' will also be supported.

You can find a list of all supported document types by using autogen.retrieve_utils.TEXT_FORMATS.

Example notebooks:

Automated Code Generation and Question Answering with Retrieval Augmented Agents

Group Chat with Retrieval Augmented Generation (with 5 group member agents and 1 manager agent)

Automated Code Generation and Question Answering with Qdrant based Retrieval Augmented Agents

Teachability

To use Teachability, please install AutoGen with the [teachable] option.

pip install "pyautogen[teachable]"

Example notebook: Chatting with a teachable agent

Large Multimodal Model (LMM) Agents

We offered Multimodal Conversable Agent and LLaVA Agent. Please install with the [lmm] option to use it.

pip install "pyautogen[lmm]"

Example notebooks:

LLaVA Agent

mathchat

pyautogen<0.2 offers an experimental agent for math problem solving. Please install with the [mathchat] option to use it.

pip install "pyautogen[mathchat]<0.2"

Example notebooks:

Using MathChat to Solve Math Problems