[![Open in OpenXLab](https://cdn-static.openxlab.org.cn/app-center/openxlab_app.svg)](https://openxlab.org.cn/apps/detail/mzr1996/AgentLego)
[![docs](https://img.shields.io/badge/docs-latest-blue)](https://agentlego.readthedocs.io/en/latest/)
[![PyPI](https://img.shields.io/pypi/v/agentlego)](https://pypi.org/project/agentlego)
[![license](https://img.shields.io/github/license/InternLM/agentlego.svg)](https://github.com/InternLM/agentlego/tree/main/LICENSE)
English | [简体中文](./README_zh-CN.md)
Introduction
AgentLego is an open-source library of versatile tool APIs to extend and enhance large language model (LLM) based agents, with the following highlight features:
- Rich set of tools for multimodal extensions of LLM agents including visual perception, image generation and editing, speech processing and visual-language reasoning, etc.
- Flexible tool interface that allows users to easily extend custom tools with arbitrary types of arguments and outputs.
- Easy integration with LLM-based agent frameworks like LangChain, Transformers Agents, Lagent.
- Support tool serving and remote accessing, which is especially useful for tools with heavy ML models (e.g. ViT) or special environment requirements (e.g. GPU and CUDA).
https://github-production-user-asset-6210df.s3.amazonaws.com/26739999/289006700-2140015c-b5e0-4102-bc54-9a1b4e3db9ec.mp4
Quick Starts
Installation
Install the AgentLego package
pip install agentlego
Install tool-specific dependencies
Some tools requires extra packages, please check the readme file of the tool, and confirm all requirements are
satisfied.
For example, if we want to use the ImageDescription
tool. We need to check the Set up section of
readme and install the requirements.
pip install -U openmim
mim install -U mmpretrain
Use tools directly
from agentlego import list_tools, load_tool
print(list_tools()) # list tools in AgentLego
image_caption_tool = load_tool('ImageDescription', device='cuda')
print(image_caption_tool.description)
image = './examples/demo.png'
caption = image_caption_tool(image)
Integrated into agent frameworks
Supported Tools
General ability
Speech related
Image-processing related
- ImageDescription: Describe the input image.
- OCR: Recognize the text from a photo.
- VQA: Answer the question according to the image.
- HumanBodyPose: Estimate the pose or keypoints of human in an image.
- HumanFaceLandmark: Estimate the landmark or keypoints of human faces in an image.
- ImageToCanny: Extract the edge image from an image.
- ImageToDepth: Generate the depth image of an image.
- ImageToScribble: Generate a sketch scribble of an image.
- ObjectDetection: Detect all objects in the image.
- TextToBbox: Detect specific objects described by the given text in the image.
- Segment Anything series
- SegmentAnything: Segment all items in the image.
- SegmentObject: Segment the certain objects in the image according to the given object name.
AIGC related
- TextToImage: Generate an image from the input text.
- ImageExpansion: Expand the peripheral area of an image based on its content.
- ObjectRemove: Remove the certain objects in the image.
- ObjectReplace: Replace the certain objects in the image.
- ImageStylization: Modify an image according to the instructions.
- ControlNet series
- CannyTextToImage: Generate an image from a canny edge image and a description.
- DepthTextToImage: Generate an image from a depth image and a description.
- PoseToImage: Generate an image from a human pose image and a description.
- ScribbleTextToImage: Generate an image from a sketch scribble image and a description.
- ImageBind series
Licence
This project is released under the Apache 2.0 license. Users should also ensure compliance with the licenses governing the models used in this project.