Skip to content

Commit

Permalink
[DOCS][Model Examples]
Browse files Browse the repository at this point in the history
  • Loading branch information
kyegomez committed Jan 10, 2025
1 parent bbdeddd commit e15bd06
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/swarms/examples/claude.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Agent with Anthropic/Claude

- Get their api keys and put it in the `.env`

- Select your model_name like `claude-3-sonnet-20240229` follows LiteLLM conventions


Expand Down
1 change: 1 addition & 0 deletions docs/swarms/examples/cohere.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Agent with Cohere

- Add your `COHERE_API_KEY` in the `.env` file

- Select your model_name like `command-r` follows LiteLLM conventions


Expand Down
2 changes: 2 additions & 0 deletions docs/swarms/examples/deepseek.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Agent with DeepSeek

- Add your `DEEPSEEK_API_KEY` in the `.env` file

- Select your model_name like `deepseek/deepseek-chat` follows [LiteLLM conventions](https://docs.litellm.ai/docs/providers/deepseek)

- Execute your agent!


Expand Down
1 change: 1 addition & 0 deletions docs/swarms/examples/groq.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Agent with Groq

- Add your `GROQ_API_KEY`

```python
import os
Expand Down
24 changes: 24 additions & 0 deletions docs/swarms/examples/ollama.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Agent with Ollama

- No API key needed
- Select your model_name like `ollama/llama2` follows [LiteLLM conventions](https://docs.litellm.ai/docs/providers/ollama)


```python
from swarms import Agent
import os
from dotenv import load_dotenv

load_dotenv()

# Initialize the agent with ChromaDB memory
agent = Agent(
agent_name="Financial-Analysis-Agent",
model_name="ollama/llama2",
system_prompt="Agent system prompt here",
agent_description="Agent performs financial analysis.",
)

# Run a query
agent.run("What are the components of a startup's stock incentive equity plan?")
```
3 changes: 3 additions & 0 deletions docs/swarms/examples/openai_example.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Agent with GPT-4o-Mini

- Add `OPENAI_API_KEY="your_key"` to your `.env` file
- Select your model like `gpt-4o-mini` or `gpt-4o`

```python
from swarms import Agent

Expand Down

0 comments on commit e15bd06

Please sign in to comment.