-
Notifications
You must be signed in to change notification settings - Fork 730
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
Conversation
There was a problem hiding this 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-
- add colab sharing link
- fix camel's version installed
- 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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @liuxukun2000 !
- we need to add link to colab notebook, please refer to out cookbook template
- could we only keep the INFO from runtime and remove other unrelated warming or info?
- use one specific version of camel
- add the guidance when should use which runtime
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
There was a problem hiding this 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
The colab notebook link is still missing. Please refer to the documentation regarding how to write up the cookbook and the template cookbook |
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 |
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 #15213Types of changes
What types of changes does your code introduce? Put an
x
in all the boxes that apply:Implemented Tasks
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!