camel icon indicating copy to clipboard operation
camel copied to clipboard

feat: Add serve module and cli tools

Open ocss884 opened this issue 1 year ago • 3 comments

This PR aims to add our own openai-compatible API server and command line tools with the help of Systemd. TODO:

  • [ ] add test case
  • [ ] complete documentation
  • [ ] better variable naming (need everyone's help)
  • [ ] lazy loading command

ocss884 avatar Feb 26 '24 12:02 ocss884

[!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.

Walkthrough

The updates introduce a comprehensive command-line interface and server functionality for the Camel service, focusing on chatbot interactions and model management. It includes licensing updates, a CLI for service operations, enhanced text generation capabilities, model management, non-blocking server execution, an OpenAI-compatible API server, utility functions for model loading and GPU usage, and improved server type definitions for request and response handling.

Changes

File(s) Summary
camel/serve/__init__.py, .../model_manager.py Introduced licensing information and imported CLI functionalities.
camel/serve/cli.py Added a CLI for managing the Camel service, including chatbot interaction and model management.
camel/serve/inference.py Enhanced text generation with translation of parameters and handling the generation process.
camel/serve/non_block.py Added functionality for running the server in the background using threading and uvicorn.
camel/serve/openai_api_server.py Introduced an OpenAI-compatible API server for chat completions with FastAPI and aiohttp.
camel/serve/utils.py, camel/utils/__init__.py Utility functions for model loading from Hugging Face and exporting messages_to_prompt.
camel/types/server_types.py Defined data models for chat completion requests/responses and model management.

🐇✨
In the land of code and lore,
Came the Camel, ready to explore.
With CLI commands, it dances,
Managing chats and model stances.
Through server's night, it runs with glee,
A service for all, open and free.
🌟🐾


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 as 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.

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.

coderabbitai[bot] avatar Feb 26 '24 12:02 coderabbitai[bot]

Hi! @dandansamax @Wendong-Fan Do you have time to take a look at this PR and give me some feedback?

ocss884 avatar Mar 13 '24 11:03 ocss884

Hi! @dandansamax @Wendong-Fan Do you have time to take a look at this PR and give me some feedback?

@ocss884 thanks for the contribution, will do the review later this week, please fix pre-commit error when you have time

Wendong-Fan avatar Mar 14 '24 16:03 Wendong-Fan