camel-ai
Some markdown tutorials for the important modules
Description
Describe your changes in detail.
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)
- [x] 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!
- [x] 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.
Hi @hidjq. Thanks for the PR. Some of the modules have been changed. Would you mind splitting the PR into multiple ones? How about let's get started with the ChatAgent?
@Obs01ete I believe some of the files are outdated in this PR.
For instance, in the ChatAgent, we have
user_msg = BaseMessage(
role_name="Patient",
role_type=RoleType.USER,
role = "user",
meta_dict=dict(),content="Hello!"
)
however, the role was removed.
Do you suggest not to include this PR into the release? @lightaime
We need to regenerate these tutorials. I guess for the release we will only need a tutorial for the ChatAgent.