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: Integrate video reading #883

Merged
merged 42 commits into from
Nov 24, 2024
Merged

feat: Integrate video reading #883

merged 42 commits into from
Nov 24, 2024

Conversation

ZackYule
Copy link
Collaborator

@ZackYule ZackYule commented Aug 31, 2024

Description

Download the video using yt-dlp and provide it to the multimodal agent for analysis. Two download options are available: full download and block download.

Motivation and Context

close #744

  • 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

  • Subtask 1
  • Subtask 2
  • Subtask 3

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.

@ZackYule ZackYule self-assigned this Aug 31, 2024
Copy link

coderabbitai bot commented Aug 31, 2024

Important

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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

@Wendong-Fan Wendong-Fan left a comment

Choose a reason for hiding this comment

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

Thanks @ZackYule ! Left some initial comments in below

camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
Copy link
Member

@Wendong-Fan Wendong-Fan left a comment

Choose a reason for hiding this comment

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

I added one more commit to polish the docstring format here, please take a look here 0e3ad4f

seems many not related files have been added to this PR, could you clean those files? Thanks @ZackYule

@ZackYule
Copy link
Collaborator Author

ZackYule commented Sep 12, 2024

I added one more commit to polish the docstring format here, please take a look here 0e3ad4f

seems many not related files have been added to this PR, could you clean those files? Thanks @ZackYule

Thank you! @Wendong-Fan . During the testing process, I found that our test folder was named test instead of tests, which does not conform to usual naming conventions and cannot be recognized by vscode's testing module. Therefore, I made changes to these files.

@Wendong-Fan
Copy link
Member

I added one more commit to polish the docstring format here, please take a look here 0e3ad4f
seems many not related files have been added to this PR, could you clean those files? Thanks @ZackYule

Thank you! @Wendong-Fan . During the testing process, I found that our test folder was named test instead of tests, which does not conform to usual naming conventions and cannot be recognized by vscode's testing module. Therefore, I made changes to these files.

I see, thanks @ZackYule

Copy link
Member

@Wendong-Fan Wendong-Fan left a comment

Choose a reason for hiding this comment

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

Thanks @ZackYule 's update, some comments below, please also solve conflicts with master branch

camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
Comment on lines 67 to 71
print(
f'''Warning: cookies.txt file not found at path
{cookies_path}.'''
)
self._cookies_path = None
Copy link
Member

Choose a reason for hiding this comment

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

here we can return the warning message directly for agent using

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks @Wendong-Fan! This is a good idea. However, when we download certain videos, cookies may not be necessary. So this is just a warning and does not terminate the program.

camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
Zack added 4 commits September 13, 2024 16:50
- Added calculate_file_hash and file_exists_and_is_identical functions to utils/__init__.py
- Added test_video_screenshots_download function to test_video_function.py

print(f"Trying to download video from: {video_url}")
try:
downloader = VideoDownloaderToolkit(video_url=video_url)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I believe that we need to understand how to support multi modal capability. The toolkits are defined for the agent. I think that the ideal way is the agent could figure out the steps by itself, instead of that developers call the toolkit functions to process the data and pass the final results to the agent.

Copy link
Member

Choose a reason for hiding this comment

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

For now if we want to make it fully automatic we need to define another agent to handle multi-modal information, I think we can finish the functionality part first and add further support if possible

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Because the agent currently has multiple input channels, I think we should first manage the selection of these input channels in the next step.

camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved
camel/toolkits/video_toolkit.py Outdated Show resolved Hide resolved

print(f"Trying to download video from: {video_url}")
try:
downloader = VideoDownloaderToolkit(video_url=video_url)
Copy link
Member

Choose a reason for hiding this comment

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

For now if we want to make it fully automatic we need to define another agent to handle multi-modal information, I think we can finish the functionality part first and add further support if possible

Zack added 5 commits September 23, 2024 09:21
…r and update usage in web_video_object_recognition.py, web_video_description_extractor.py, and test_video_function.py
@Wendong-Fan Wendong-Fan changed the title Integrate video reading feat: Integrate video reading Sep 26, 2024
Copy link
Member

@Wendong-Fan Wendong-Fan left a comment

Choose a reason for hiding this comment

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

Thanks @WHALEEYE , left some comments below and added one more commit based on comment here: bb868dd , could you also verify and update the 3 examples, for now it's not align with our updated code, thanks!

self.chunk_duration = chunk_duration
self.yt_dlp = importlib.import_module('yt_dlp')
self._chunk_durations: list[int] = []
self._cookies_path: Optional[str] = None
Copy link
Member

Choose a reason for hiding this comment

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

cookies path only used in def cookies_path, I feel it's not necessary to set this as global variable

download_directory or tempfile.mkdtemp()
).resolve()

print(f"self._download_directory: {self._download_directory}")
Copy link
Member

Choose a reason for hiding this comment

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

unify by using logger.info?

Comment on lines 143 to 144
# Download the video and get the filename
info = ydl.extract_info(url, download=True)
Copy link
Member

Choose a reason for hiding this comment

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

add logger info here

info = ydl.extract_info(url, download=True)
return ydl.prepare_filename(info)
except yt_dlp.utils.DownloadError as e:
raise RuntimeError(f"Failed to download video: {e}")
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
raise RuntimeError(f"Failed to download video: {e}")
raise RuntimeError(f"Failed to download video from {url}: {e}")

Comment on lines 196 to 197
if isinstance(timestamps, int):
interval = video_length // (timestamps + 1)
Copy link
Member

Choose a reason for hiding this comment

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

add check for timestamps <= 0


if isinstance(timestamps, int):
interval = video_length // (timestamps + 1)
tss = [int((i + 1) * interval) for i in range(timestamps)]
Copy link
Member

Choose a reason for hiding this comment

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

tts could be 0 if timestamps is very small

Comment on lines 207 to 213
r"""Returns a list of OpenAIFunction objects representing the
functions in the toolkit.

Returns:
List[OpenAIFunction]: A list of OpenAIFunction objects representing
the functions in the toolkit.
"""
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
r"""Returns a list of OpenAIFunction objects representing the
functions in the toolkit.
Returns:
List[OpenAIFunction]: A list of OpenAIFunction objects representing
the functions in the toolkit.
"""
r"""Returns a list of FunctionTool objects representing the
functions in the toolkit.
Returns:
List[FunctionTool]: A list of FunctionTool objects representing
the functions in the toolkit.
"""

Copy link
Member

Choose a reason for hiding this comment

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

need to be updated and verified

@Wendong-Fan Wendong-Fan merged commit 2e7dcdc into master Nov 24, 2024
4 of 6 checks passed
@Wendong-Fan Wendong-Fan deleted the integrate-video-reading branch November 24, 2024 10:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Reviewing
4 participants