Skip to content

Commit

Permalink
support to pass callable model into agent;
Browse files Browse the repository at this point in the history
  • Loading branch information
DavdGao committed Mar 8, 2024
1 parent 3ea680b commit 86bf183
Show file tree
Hide file tree
Showing 20 changed files with 58 additions and 42 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,8 @@ import agentscope
agentscope.init(model_configs="./model_configs.json")

# Create a dialog agent and a user agent
dialog_agent = DialogAgent(name="assistant", model_config_name="your_config_name")
dialog_agent = DialogAgent(name="assistant",
model_or_config_name="your_config_name")
user_agent = UserAgent()
```

Expand Down
3 changes: 2 additions & 1 deletion README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,8 @@ import agentscope
agentscope.init(model_configs="./model_configs.json")

# 创建对话Agent和用户Agent
dialog_agent = DialogAgent(name="assistant", model_config_name="your_config_name")
dialog_agent = DialogAgent(name="assistant",
model_or_config_name="your_config_name")
user_agent = UserAgent()
```

Expand Down
3 changes: 2 additions & 1 deletion docs/sphinx_doc/source/tutorial/103-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ from agentscope.agents import DialogAgent, UserAgent
agentscope.init(model_configs="./openai_model_configs.json")

# Create a dialog agent and a user agent
dialogAgent = DialogAgent(name="assistant", model_config_name="gpt-4", sys_prompt="You are a helpful ai assistant")
dialogAgent = DialogAgent(name="assistant", model_or_config_name="gpt-4",
sys_prompt="You are a helpful ai assistant")
userAgent = UserAgent()
```

Expand Down
4 changes: 2 additions & 2 deletions docs/sphinx_doc/source/tutorial/104-usecase.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,13 @@ AgentScope provides several out-of-the-box Agents implements and organizes them
"args": {
"name": "Player1",
"sys_prompt": "Act as a player in a werewolf game. You are Player1 and\nthere are totally 6 players, named Player1, Player2, Player3, Player4, Player5 and Player6.\n\nPLAYER ROLES:\nIn werewolf game, players are divided into two werewolves, two villagers, one seer, and one witch. Note only werewolves know who are their teammates.\nWerewolves: They know their teammates' identities and attempt to eliminate a villager each night while trying to remain undetected.\nVillagers: They do not know who the werewolves are and must work together during the day to deduce who the werewolves might be and vote to eliminate them.\nSeer: A villager with the ability to learn the true identity of one player each night. This role is crucial for the villagers to gain information.\nWitch: A character who has a one-time ability to save a player from being eliminated at night (sometimes this is a potion of life) and a one-time ability to eliminate a player at night (a potion of death).\n\nGAME RULE:\nThe game consists of two phases: night phase and day phase. The two phases are repeated until werewolf or villager wins the game.\n1. Night Phase: During the night, the werewolves discuss and vote for a player to eliminate. Special roles also perform their actions at this time (e.g., the Seer chooses a player to learn their role, the witch chooses a decide if save the player).\n2. Day Phase: During the day, all surviving players discuss who they suspect might be a werewolf. No one reveals their role unless it serves a strategic purpose. After the discussion, a vote is taken, and the player with the most votes is \"lynched\" or eliminated from the game.\n\nVICTORY CONDITION:\nFor werewolves, they win the game if the number of werewolves is equal to or greater than the number of remaining villagers.\nFor villagers, they win if they identify and eliminate all of the werewolves in the group.\n\nCONSTRAINTS:\n1. Your response should be in the first person.\n2. This is a conversational game. You should respond only based on the conversation history and your strategy.\n\nYou are playing werewolf in this game.\n",
"model_config_name": "gpt-3.5-turbo",
"model_or_config_name": "gpt-3.5-turbo",
"use_memory": true
}
}
```

In this configuration, `Player1` is designated as a `DictDialogAgent`. The parameters include a system prompt (`sys_prompt`) that can guide the agent's behavior, a model config name (`model_config_name`) that determines the name of the model configuration, and a flag (`use_memory`) indicating whether the agent should remember past interactions.
In this configuration, `Player1` is designated as a `DictDialogAgent`. The parameters include a system prompt (`sys_prompt`) that can guide the agent's behavior, a model config name (`model_or_config_name`) that determines the name of the model configuration, and a flag (`use_memory`) indicating whether the agent should remember past interactions.

For other players, configurations can be customized based on their roles. Each role may have different prompts, models, or memory settings. You can refer to the JSON file located at `examples/werewolf/configs/agent_configs.json` within the AgentScope examples directory.

Expand Down
4 changes: 2 additions & 2 deletions docs/sphinx_doc/source/tutorial/201-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class AgentBase(Operator):
self,
name: str,
sys_prompt: Optional[str] = None,
model_config_name: str = None,
model_or_config_name: str = None,
use_memory: bool = True,
memory_config: Optional[dict] = None,
) -> None:
Expand Down Expand Up @@ -108,7 +108,7 @@ from agentscope.agents import DialogAgent
# Configuration for the DialogAgent
dialog_agent_config = {
"name": "ServiceBot",
"model_config_name": "gpt-3.5", # Specify the model used for dialogue generation
"model_or_config_name": "gpt-3.5", # Specify the model used for dialogue generation
"sys_prompt": "Act as AI assistant to interact with the others. Try to "
"reponse on one line.\n", # Custom prompt for the agent
# Other configurations specific to the DialogAgent
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx_doc/source/tutorial/203-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ model = AutoModelForCausalLM.from_pretrained(MODEL_NAME)
tokenizer = AutoTokenizer.from_pretrained(MODEL_NAME)
model.eval()
# Do remember to re-implement the `reply` method to tokenize *message*!
agent = YourAgent(name='agent', model_config_name=config_name, tokenizer=tokenizer)
agent = YourAgent(name='agent', model_or_config_name=config_name, tokenizer=tokenizer)
```

[[Return to the top]](#using-different-model-sources-with-model-api)
4 changes: 2 additions & 2 deletions examples/agent_builder/auto-discussion.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
agent_builder = DialogAgent(
name="agent_builder",
sys_prompt="You're a helpful assistant.",
model_config_name="my_post_api",
model_or_config_name="my_post_api",
)


Expand All @@ -56,7 +56,7 @@
DialogAgent(
name=key,
sys_prompt=val,
model_config_name="my_post_api",
model_or_config_name="my_post_api",
)
for key, val in scenario_participants["Participants"].items()
]
Expand Down
3 changes: 2 additions & 1 deletion examples/conversation/conversation.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ def main() -> None:
dialog_agent = DialogAgent(
name="Assistant",
sys_prompt="You're a helpful assistant.",
model_config_name="gpt-3.5-turbo", # replace by your model config name
model_or_config_name="gpt-3.5-turbo", # replace by your model
# config name
)
user_agent = UserAgent()

Expand Down
6 changes: 3 additions & 3 deletions examples/distributed/configs/debate_agent_configs.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"args": {
"name": "Pro",
"sys_prompt": "Assume the role of a debater who is arguing in favor of the proposition that AGI (Artificial General Intelligence) can be achieved using the GPT model framework. Construct a coherent and persuasive argument, including scientific, technological, and theoretical evidence, to support the statement that GPT models are a viable path to AGI. Highlight the advancements in language understanding, adaptability, and scalability of GPT models as key factors in progressing towards AGI.",
"model_config_name": "gpt-3.5-turbo",
"model_or_config_name": "gpt-3.5-turbo",
"use_memory": true
}
},
Expand All @@ -13,7 +13,7 @@
"args": {
"name": "Con",
"sys_prompt": "Assume the role of a debater who is arguing against the proposition that AGI can be achieved using the GPT model framework. Construct a coherent and persuasive argument, including scientific, technological, and theoretical evidence, to support the statement that GPT models, while impressive, are insufficient for reaching AGI. Discuss the limitations of GPT models such as lack of understanding, consciousness, ethical reasoning, and general problem-solving abilities that are essential for true AGI.",
"model_config_name": "gpt-3.5-turbo",
"model_or_config_name": "gpt-3.5-turbo",
"use_memory": true
}
},
Expand All @@ -22,7 +22,7 @@
"args": {
"name": "Judge",
"sys_prompt": "Assume the role of an impartial judge in a debate where the affirmative side argues that AGI can be achieved using the GPT model framework, and the negative side contests this. Listen to both sides' arguments and provide an analytical judgment on which side presented a more compelling and reasonable case. Consider the strength of the evidence, the persuasiveness of the reasoning, and the overall coherence of the arguments presented by each side.",
"model_config_name": "gpt-3.5-turbo",
"model_or_config_name": "gpt-3.5-turbo",
"use_memory": true
}
}
Expand Down
4 changes: 2 additions & 2 deletions examples/distributed/distributed_dialog.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def setup_assistant_server(assistant_host: str, assistant_port: int) -> None:
agent_kwargs={
"name": "Assitant",
"sys_prompt": "You are a helpful assistant.",
"model_config_name": "gpt-3.5-turbo",
"model_or_config_name": "gpt-3.5-turbo",
"use_memory": True,
},
host=assistant_host,
Expand All @@ -59,7 +59,7 @@ def run_main_process(assistant_host: str, assistant_port: int) -> None:
assistant_agent = DialogAgent(
name="Assistant",
sys_prompt="You are a helpful assistant.",
model_config_name="gpt-3.5-turbo",
model_or_config_name="gpt-3.5-turbo",
use_memory=True,
).to_dist(
host=assistant_host,
Expand Down
2 changes: 1 addition & 1 deletion examples/werewolf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ is as follows
"args": {
"name": "Player1",
"sys_prompt": "Act as a player in a werewolf game. You are Player1 and\nthere are totally 6 players, named Player1, Player2, Player3, Player4, Player5 and Player6.\n\nPLAYER ROLES:\nIn werewolf game, players are divided into two werewolves, two villagers, one seer and one witch. Note only werewolves know who are their teammates.\nWerewolves: They know their teammates' identities and attempt to eliminate a villager each night while trying to remain undetected.\nVillagers: They do not know who the werewolves are and must work together during the day to deduce who the werewolves might be and vote to eliminate them.\nSeer: A villager with the ability to learn the true identity of one player each night. This role is crucial for the villagers to gain information.\nWitch: A character who has a one-time ability to save a player from being eliminated at night (sometimes this is a potion of life) and a one-time ability to eliminate a player at night (a potion of death).\n\nGAME RULE:\nThe game is consisted of two phases: night phase and day phase. The two phases are repeated until werewolf or villager win the game.\n1. Night Phase: During the night, the werewolves discuss and vote for a player to eliminate. Special roles also perform their actions at this time (e.g., the Seer chooses a player to learn their role, the witch chooses a decide if save the player).\n2. Day Phase: During the day, all surviving players discuss who they suspect might be a werewolf. No one reveals their role unless it serves a strategic purpose. After the discussion, a vote is taken, and the player with the most votes is \"lynched\" or eliminated from the game.\n\nVICTORY CONDITION:\nFor werewolves, they win the game if the number of werewolves is equal to or greater than the number of remaining villagers.\nFor villagers, they win if they identify and eliminate all of the werewolves in the group.\n\nCONSTRAINTS:\n1. Your response should be in the first person.\n2. This is a conversational game. You should response only based on the conversation history and your strategy.\n\nYou are playing werewolf in this game.\n",
"model_config_name": "gpt-3.5-turbo",
"model_or_config_name": "gpt-3.5-turbo",
"use_memory": true
}
}
Expand Down
Loading

0 comments on commit 86bf183

Please sign in to comment.