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

docs: add runtime cookbook #1315

Closed
wants to merge 4 commits into from
Closed

docs: add runtime cookbook #1315

wants to merge 4 commits into from

Conversation

liuxukun2000
Copy link
Collaborator

Description

Add runtime cookbook as per Guohao's comment.

Motivation and Context

Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
You can use the syntax close #15213 if this solves the issue #15213

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

@liuxukun2000 liuxukun2000 added the documentation Improvements or additions to documentation label Dec 13, 2024
@liuxukun2000 liuxukun2000 self-assigned this Dec 13, 2024
@liuxukun2000 liuxukun2000 marked this pull request as ready for review December 13, 2024 06:05
@Wendong-Fan Wendong-Fan changed the title Add runtime cookbook docs: add runtime cookbook Dec 17, 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 @liuxukun2000 ! could you refer to https://github.com/camel-ai/camel/blob/master/CONTRIBUTING.md#contributing-to-the-cookbook-writing-

  1. add colab sharing link
  2. fix camel's version installed
  3. add more detailed cases to better show case this module, like for LLMGuardRuntime, show the risk score for different input

I think based on current content we can also add runtime introduction under our core module doc part, we can create the other PR to do this

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 @liuxukun2000 !

  1. we need to add link to colab notebook, please refer to out cookbook template
  2. could we only keep the INFO from runtime and remove other unrelated warming or info?
  3. use one specific version of camel
  4. add the guidance when should use which runtime

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Collaborator

@koch3092 koch3092 left a comment

Choose a reason for hiding this comment

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

Looks good to me

@willshang76
Copy link
Collaborator

The colab notebook link is still missing. Please refer to the documentation regarding how to write up the cookbook and the template cookbook

@liuxukun2000
Copy link
Collaborator Author

Hi @willshang76, thank you for pointing that out. The Colab notebook link is not included because Colab does not support port listening or Docker integration. I’ve already discussed this with Wendong, and we’ve decided not to include this as a cookbook. Instead, it will be provided as part of the documentation.

@willshang76
Copy link
Collaborator

Hi @willshang76, thank you for pointing that out. The Colab notebook link is not included because Colab does not support port listening or Docker integration. I’ve already discussed this with Wendong, and we’ve decided not to include this as a cookbook. Instead, it will be provided as part of the documentation.

Thanks for the context

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants