Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

Add collab to README (#17)

Hani Itaniff32c70e0276
diff --git a/README.md b/README.md
index 57efb6133..94eeaaeda 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ The objective of this project is to study how an AI society would function, beha
Overall, this project has the potential to open up new possibilities for collaboration between machines. By simulating communication between agents, we can gain insights into how AI could function in society and identify areas for improvement. Ultimately, this research could have far-reaching implications for the development of intelligent systems and the future of AI.
## Try it yourself
-We provide a Google Collab demo showcasing a conversation between two ChatGPT agents impersonationg a gamer as a user and a game developer as a domain expert collaborating on interesting tasks.
+We provide a [Google Collab](https://colab.research.google.com/drive/1AzP33O8rnMW__7ocWJhVBXjKziJXPtim?usp=sharing) demo showcasing a conversation between two ChatGPT agents impersonationg a gamer as a user and a computer programmer as a domain expert collaborating on developing a game using PyGame.
<p align="center">
@@ -18,15 +18,6 @@ We provide a Google Collab demo showcasing a conversation between two ChatGPT ag
</p>
## Environment Setup
-Install `CAMEL` using conda environment:
-```
-# create a conda virtual environment
-conda create --name camel python=3.10
-# actiavte camel conda environment
-conda activate camel
-# install camel pip package
-pip install camel
-```
Install `CAMEL` from source with conda:
```
@@ -42,6 +33,18 @@ cd camel
pre-commit install
pip install -e .
```
+
+## Example
+You can find a list of tasks for different set of assistant and user role pairs [here](https://drive.google.com/file/d/194PPaSTBR07m-PzjS-Ty6KlPLdFIPQDd/view?usp=share_link)
+
+Run the `role_playing.py` script.
+```
+# export your OpenAI API key
+export OPENAI_API_KEY=<insert your OpenAI API key>
+# You can change the role pair and initial prompt in role_playing.py
+python examples/role_playing.py
+```
+
## News
- Initial release of `CAMEL` python library (March 21, 2023)