Skip to content

Commit d0e3722

Browse files
authored
docs: Polish camel installation part (#644)
1 parent 6bdbceb commit d0e3722

File tree

2 files changed

+29
-20
lines changed

2 files changed

+29
-20
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ To install the base CAMEL library:
5555
pip install camel-ai
5656
```
5757
Some features require extra dependencies:
58+
- To install with all dependencies:
59+
```bash
60+
pip install 'camel-ai[all]'
61+
```
5862
- To use the HuggingFace agents:
5963
```bash
6064
pip install 'camel-ai[huggingface-agent]'
@@ -63,10 +67,6 @@ Some features require extra dependencies:
6367
```bash
6468
pip install 'camel-ai[tools]'
6569
```
66-
- To install with all dependencies:
67-
```bash
68-
pip install 'camel-ai[all]'
69-
```
7070

7171
### From Source
7272

@@ -81,14 +81,20 @@ git clone https://github.com/camel-ai/camel.git
8181
# Change directory into project directory
8282
cd camel
8383
84-
# Activate camel virtual environment
84+
# If you didn't install peotry before
85+
pip install poetry # (Optional)
86+
87+
# We suggest using python 3.10
88+
poetry env use python3.10 # (Optional)
89+
90+
# Activate CAMEL virtual environment
8591
poetry shell
8692
87-
# Install camel from source
88-
# It takes about 90 seconds to resolve dependencies
93+
# Install the base CAMEL library
94+
# It takes about 90 seconds
8995
poetry install
9096
91-
# Or if you want to use all other extra packages
97+
# Install CAMEL with all dependencies
9298
poetry install -E all # (Optional)
9399
94100
# Exit the virtual environment
@@ -100,7 +106,7 @@ Install `CAMEL` from source with conda and pip:
100106
# Create a conda virtual environment
101107
conda create --name camel python=3.10
102108
103-
# Activate camel conda environment
109+
# Activate CAMEL conda environment
104110
conda activate camel
105111
106112
# Clone github repo
@@ -109,7 +115,7 @@ git clone -b v0.1.5.1 https://github.com/camel-ai/camel.git
109115
# Change directory into project directory
110116
cd camel
111117
112-
# Install camel from source
118+
# Install CAMEL from source
113119
pip install -e .
114120
115121
# Or if you want to use all other extra packages

docs/get_started/setup.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ To install the base CAMEL library:
77
pip install camel-ai
88
```
99
Some features require extra dependencies:
10+
- To install with all dependencies:
11+
```bash
12+
pip install 'camel-ai[all]'
13+
```
1014
- To use the HuggingFace agents:
1115
```bash
1216
pip install 'camel-ai[huggingface-agent]'
@@ -15,10 +19,6 @@ Some features require extra dependencies:
1519
```bash
1620
pip install 'camel-ai[tools]'
1721
```
18-
- To install with all dependencies:
19-
```bash
20-
pip install 'camel-ai[all]'
21-
```
2222

2323
### [Option 2] Install from Source
2424
#### Install from Source with Poetry
@@ -32,17 +32,20 @@ git clone https://github.com/camel-ai/camel.git
3232
# Change directory into project directory
3333
cd camel
3434
35+
# If you didn't install peotry before
36+
pip install poetry # (Optional)
37+
3538
# We suggest using python 3.10
3639
poetry env use python3.10 # (Optional)
3740
38-
# Activate camel virtual environment
41+
# Activate CAMEL virtual environment
3942
poetry shell
4043
41-
# Install camel from source
42-
# It takes about 90 seconds to resolve dependencies
44+
# Install the base CAMEL library
45+
# It takes about 90 seconds
4346
poetry install
4447
45-
# Or if you want to use all other extra packages
48+
# Install CAMEL with all dependencies
4649
poetry install -E all # (Optional)
4750
4851
# Exit the virtual environment
@@ -54,7 +57,7 @@ exit
5457
# Create a conda virtual environment
5558
conda create --name camel python=3.10
5659
57-
# Activate camel conda environment
60+
# Activate CAMEL conda environment
5861
conda activate camel
5962
6063
# Clone github repo
@@ -63,7 +66,7 @@ git clone -b v0.1.5.1 https://github.com/camel-ai/camel.git
6366
# Change directory into project directory
6467
cd camel
6568
66-
# Install camel from source
69+
# Install CAMEL from source
6770
pip install -e .
6871
6972
# Or if you want to use all other extra packages

0 commit comments

Comments
 (0)