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

docs: Polish camel installation part (#644)

Wendong-Fand0e3722df22e
diff --git a/README.md b/README.md
index 4c3222315..c7ca7014f 100644
--- a/README.md
+++ b/README.md
@@ -55,6 +55,10 @@ To install the base CAMEL library:
pip install camel-ai
```
Some features require extra dependencies:
+- To install with all dependencies:
+ ```bash
+ pip install 'camel-ai[all]'
+ ```
- To use the HuggingFace agents:
```bash
pip install 'camel-ai[huggingface-agent]'
@@ -63,10 +67,6 @@ Some features require extra dependencies:
```bash
pip install 'camel-ai[tools]'
```
-- To install with all dependencies:
- ```bash
- pip install 'camel-ai[all]'
- ```
### From Source
@@ -81,14 +81,20 @@ git clone https://github.com/camel-ai/camel.git
# Change directory into project directory
cd camel
-# Activate camel virtual environment
+# If you didn't install peotry before
+pip install poetry # (Optional)
+
+# We suggest using python 3.10
+poetry env use python3.10 # (Optional)
+
+# Activate CAMEL virtual environment
poetry shell
-# Install camel from source
-# It takes about 90 seconds to resolve dependencies
+# Install the base CAMEL library
+# It takes about 90 seconds
poetry install
-# Or if you want to use all other extra packages
+# Install CAMEL with all dependencies
poetry install -E all # (Optional)
# Exit the virtual environment
@@ -100,7 +106,7 @@ Install `CAMEL` from source with conda and pip:
# Create a conda virtual environment
conda create --name camel python=3.10
-# Activate camel conda environment
+# Activate CAMEL conda environment
conda activate camel
# Clone github repo
@@ -109,7 +115,7 @@ git clone -b v0.1.5.1 https://github.com/camel-ai/camel.git
# Change directory into project directory
cd camel
-# Install camel from source
+# Install CAMEL from source
pip install -e .
# Or if you want to use all other extra packages
diff --git a/docs/get_started/setup.md b/docs/get_started/setup.md
index e727b9c0e..ea3331493 100644
--- a/docs/get_started/setup.md
+++ b/docs/get_started/setup.md
@@ -7,6 +7,10 @@ To install the base CAMEL library:
pip install camel-ai
```
Some features require extra dependencies:
+- To install with all dependencies:
+ ```bash
+ pip install 'camel-ai[all]'
+ ```
- To use the HuggingFace agents:
```bash
pip install 'camel-ai[huggingface-agent]'
@@ -15,10 +19,6 @@ Some features require extra dependencies:
```bash
pip install 'camel-ai[tools]'
```
-- To install with all dependencies:
- ```bash
- pip install 'camel-ai[all]'
- ```
### [Option 2] Install from Source
#### Install from Source with Poetry
@@ -32,17 +32,20 @@ git clone https://github.com/camel-ai/camel.git
# Change directory into project directory
cd camel
+# If you didn't install peotry before
+pip install poetry # (Optional)
+
# We suggest using python 3.10
poetry env use python3.10 # (Optional)
-# Activate camel virtual environment
+# Activate CAMEL virtual environment
poetry shell
-# Install camel from source
-# It takes about 90 seconds to resolve dependencies
+# Install the base CAMEL library
+# It takes about 90 seconds
poetry install
-# Or if you want to use all other extra packages
+# Install CAMEL with all dependencies
poetry install -E all # (Optional)
# Exit the virtual environment
@@ -54,7 +57,7 @@ exit
# Create a conda virtual environment
conda create --name camel python=3.10
-# Activate camel conda environment
+# Activate CAMEL conda environment
conda activate camel
# Clone github repo
@@ -63,7 +66,7 @@ git clone -b v0.1.5.1 https://github.com/camel-ai/camel.git
# Change directory into project directory
cd camel
-# Install camel from source
+# Install CAMEL from source
pip install -e .
# Or if you want to use all other extra packages