Skip to content

Commit

Permalink
docs: Polish camel installation part (#644)
Browse files Browse the repository at this point in the history
  • Loading branch information
Wendong-Fan committed Jun 15, 2024
1 parent 6bdbceb commit d0e3722
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 20 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]'
Expand All @@ -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

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
23 changes: 13 additions & 10 deletions docs/get_started/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]'
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down

0 comments on commit d0e3722

Please sign in to comment.