Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Support multi-modal input and multi-modal output in one agent #529

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Zhoues
Copy link
Member

@Zhoues Zhoues commented Apr 23, 2024

Description

Mainly implements 4 multi-modal parts:

  1. Building an agent to support multiple image inputs (see examples/vision/object_recognition.py)
  2. Building an agent to call DALL-E to generate images (see examples/vision/image_crafting.py)
  3. Building an agent to support calls to DALL-E to generate images while understanding multiple image inputs (see examples/vision/multi_condition_image_crafting.py)
  4. Build two agents one for generating the image and one for suggesting ways for the other to fix the image. (see examples/vision/multi_turn_image_refining.py)

Motivation and Context

Part of #454

also will fix #541

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds core functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Example (update in the folder of example)

Implemented Tasks

  • Supports multi-image input
  • Support DALLE function call
  • To allow an agent to receive image inputs and output images at the same time, a new FunctionCallingVisionConfig is built to adapt the ChatGPTVisionConfig
  • Create image crafting task type and example
  • Create multi-condition image crafting task type and example

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • I have read the CONTRIBUTION guide. (required)
  • My change requires a change to the documentation.
  • I have updated the tests accordingly. (required for a bug fix or a new feature)
  • I have updated the documentation accordingly.

Copy link

coderabbitai bot commented Apr 23, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Member

@yiyiyi0817 yiyiyi0817 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It appears that your code hasn't passed the CI/CD tests. I kindly suggest taking a look at https://github.com/camel-ai/camel/blob/master/CONTRIBUTING.md for guidance. Once you've resolved the formatting issues, mypy checks, and ensured that pytest is successful, hope you could resubmit your code. Thank you! @Zhoues

Additionally, it seems that this PR encompasses multiple features. I'm considering that it might be helpful if you could propose a roadmap and then break it down into several PRs for submission and review by others. This approach could facilitate a more thorough review process and ensure each feature receives the attention it deserves. Thank you for your consideration!



def image_path_to_base64(image_path):
with open(image_path, "rb") as image_file:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
with open(image_path, "rb") as image_file:
with open(image_path, "rb") as image_file:

def get_dalle_img(model: str, prompt: str, size: str, quality: str, n: int) -> str:
"""Generate an image using OpenAI's DALL-E model.
Args:
model (str): The specific DALL-E model to use for image generation, including "dall-e-3" and "dall-e-2". Defaults to "dall-e-3".
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add the dall-e as some fixed model types to https://github.com/camel-ai/camel/blob/master/camel/types/enums.py


# use local path
cache = Cache(".cache/")
key = (model, prompt, size, quality, n)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this key be unique and why we need to cache? IMO each generation can have some randomness?

return None


def get_dalle_img(model: str, prompt: str, size: str, quality: str, n: int) -> str:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a image path for the generated image

Suggested change
def get_dalle_img(model: str, prompt: str, size: str, quality: str, n: int) -> str:
def get_dalle_img(model: str, prompt: str, size: str, quality: str, n: int, image_path: str) -> str:


class ImageCraftPromptTemplateDict(TextPromptDict):
ASSISTANT_PROMPT = TextPrompt(
"""You are tasked with creating an original image based on the provided descriptive captions. Please use your imagination and artistic capabilities to visualize and draw the images and explain what you are thinking about.""")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit:

Suggested change
"""You are tasked with creating an original image based on the provided descriptive captions. Please use your imagination and artistic capabilities to visualize and draw the images and explain what you are thinking about.""")
"""You are given the task of generating an original image based on the descriptive captions. Please use your creativity and artistic skills to visualize and create an image with your thought process.""")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Developing
Development

Successfully merging this pull request may close these issues.

[BUG] ChatAgent Fails to Process Function Calls in Messages Containing Single Quotes
4 participants