🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org
Python agentai-societiesartificial-intelligencecommunicative-aicooperative-aideep-learninglarge-language-modelsmulti-agent-systemsnatural-language-processing
docs: Update doc (#1743)
Wendong-Fan0243737942e6
diff --git a/docs/camel.benchmarks.rst b/docs/camel.benchmarks.rstnew file mode 100644index 000000000..081c875c2--- /dev/null+++ b/docs/camel.benchmarks.rst@@ -0,0 +1,61 @@+camel.benchmarks package+========================++Submodules+----------++camel.benchmarks.apibank module+-------------------------------++.. automodule:: camel.benchmarks.apibank+ :members:+ :undoc-members:+ :show-inheritance:++camel.benchmarks.apibench module+--------------------------------++.. automodule:: camel.benchmarks.apibench+ :members:+ :undoc-members:+ :show-inheritance:++camel.benchmarks.base module+----------------------------++.. automodule:: camel.benchmarks.base+ :members:+ :undoc-members:+ :show-inheritance:++camel.benchmarks.gaia module+----------------------------++.. automodule:: camel.benchmarks.gaia+ :members:+ :undoc-members:+ :show-inheritance:++camel.benchmarks.nexus module+-----------------------------++.. automodule:: camel.benchmarks.nexus+ :members:+ :undoc-members:+ :show-inheritance:++camel.benchmarks.ragbench module+--------------------------------++.. automodule:: camel.benchmarks.ragbench+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.benchmarks+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.bots.discord.rst b/docs/camel.bots.discord.rstnew file mode 100644index 000000000..803e92cb7--- /dev/null+++ b/docs/camel.bots.discord.rst@@ -0,0 +1,37 @@+camel.bots.discord package+==========================++Submodules+----------++camel.bots.discord.discord\_app module+--------------------------------------++.. automodule:: camel.bots.discord.discord_app+ :members:+ :undoc-members:+ :show-inheritance:++camel.bots.discord.discord\_installation module+-----------------------------------------------++.. automodule:: camel.bots.discord.discord_installation+ :members:+ :undoc-members:+ :show-inheritance:++camel.bots.discord.discord\_store module+----------------------------------------++.. automodule:: camel.bots.discord.discord_store+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.bots.discord+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.bots.rst b/docs/camel.bots.rstnew file mode 100644index 000000000..0363cca7f--- /dev/null+++ b/docs/camel.bots.rst@@ -0,0 +1,30 @@+camel.bots package+==================++Subpackages+-----------++.. toctree::+ :maxdepth: 4++ camel.bots.discord+ camel.bots.slack++Submodules+----------++camel.bots.telegram\_bot module+-------------------------------++.. automodule:: camel.bots.telegram_bot+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.bots+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.bots.slack.rst b/docs/camel.bots.slack.rstnew file mode 100644index 000000000..379763cf9--- /dev/null+++ b/docs/camel.bots.slack.rst@@ -0,0 +1,29 @@+camel.bots.slack package+========================++Submodules+----------++camel.bots.slack.models module+------------------------------++.. automodule:: camel.bots.slack.models+ :members:+ :undoc-members:+ :show-inheritance:++camel.bots.slack.slack\_app module+----------------------------------++.. automodule:: camel.bots.slack.slack_app+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.bots.slack+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.data_collector.rst b/docs/camel.data_collector.rstnew file mode 100644index 000000000..fab25f7c6--- /dev/null+++ b/docs/camel.data_collector.rst@@ -0,0 +1,37 @@+camel.data\_collector package+=============================++Submodules+----------++camel.data\_collector.alpaca\_collector module+----------------------------------------------++.. automodule:: camel.data_collector.alpaca_collector+ :members:+ :undoc-members:+ :show-inheritance:++camel.data\_collector.base module+---------------------------------++.. automodule:: camel.data_collector.base+ :members:+ :undoc-members:+ :show-inheritance:++camel.data\_collector.sharegpt\_collector module+------------------------------------------------++.. automodule:: camel.data_collector.sharegpt_collector+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.data_collector+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.datagen.rst b/docs/camel.datagen.rstnew file mode 100644index 000000000..1fc7a8e0e--- /dev/null+++ b/docs/camel.datagen.rst@@ -0,0 +1,38 @@+camel.datagen package+=====================++Subpackages+-----------++.. toctree::+ :maxdepth: 4++ camel.datagen.self_instruct+ camel.datagen.source2synth++Submodules+----------++camel.datagen.cot\_datagen module+---------------------------------++.. automodule:: camel.datagen.cot_datagen+ :members:+ :undoc-members:+ :show-inheritance:++camel.datagen.self\_improving\_cot module+-----------------------------------------++.. automodule:: camel.datagen.self_improving_cot+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.datagen+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.datagen.self_instruct.filter.rst b/docs/camel.datagen.self_instruct.filter.rstnew file mode 100644index 000000000..4dbbc324d--- /dev/null+++ b/docs/camel.datagen.self_instruct.filter.rst@@ -0,0 +1,37 @@+camel.datagen.self\_instruct.filter package+===========================================++Submodules+----------++camel.datagen.self\_instruct.filter.filter\_function module+-----------------------------------------------------------++.. automodule:: camel.datagen.self_instruct.filter.filter_function+ :members:+ :undoc-members:+ :show-inheritance:++camel.datagen.self\_instruct.filter.filter\_registry module+-----------------------------------------------------------++.. automodule:: camel.datagen.self_instruct.filter.filter_registry+ :members:+ :undoc-members:+ :show-inheritance:++camel.datagen.self\_instruct.filter.instruction\_filter module+--------------------------------------------------------------++.. automodule:: camel.datagen.self_instruct.filter.instruction_filter+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.datagen.self_instruct.filter+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.datagen.self_instruct.rst b/docs/camel.datagen.self_instruct.rstnew file mode 100644index 000000000..c5035dd32--- /dev/null+++ b/docs/camel.datagen.self_instruct.rst@@ -0,0 +1,37 @@+camel.datagen.self\_instruct package+====================================++Subpackages+-----------++.. toctree::+ :maxdepth: 4++ camel.datagen.self_instruct.filter++Submodules+----------++camel.datagen.self\_instruct.self\_instruct module+--------------------------------------------------++.. automodule:: camel.datagen.self_instruct.self_instruct+ :members:+ :undoc-members:+ :show-inheritance:++camel.datagen.self\_instruct.templates module+---------------------------------------------++.. automodule:: camel.datagen.self_instruct.templates+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.datagen.self_instruct+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.datagen.source2synth.rst b/docs/camel.datagen.source2synth.rstnew file mode 100644index 000000000..5aced4795--- /dev/null+++ b/docs/camel.datagen.source2synth.rst@@ -0,0 +1,37 @@+camel.datagen.source2synth package+==================================++Submodules+----------++camel.datagen.source2synth.data\_processor module+-------------------------------------------------++.. automodule:: camel.datagen.source2synth.data_processor+ :members:+ :undoc-members:+ :show-inheritance:++camel.datagen.source2synth.models module+----------------------------------------++.. automodule:: camel.datagen.source2synth.models+ :members:+ :undoc-members:+ :show-inheritance:++camel.datagen.source2synth.user\_data\_processor\_config module+---------------------------------------------------------------++.. automodule:: camel.datagen.source2synth.user_data_processor_config+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.datagen.source2synth+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.datahubs.rst b/docs/camel.datahubs.rstnew file mode 100644index 000000000..dc2c98ae5--- /dev/null+++ b/docs/camel.datahubs.rst@@ -0,0 +1,37 @@+camel.datahubs package+======================++Submodules+----------++camel.datahubs.base module+--------------------------++.. automodule:: camel.datahubs.base+ :members:+ :undoc-members:+ :show-inheritance:++camel.datahubs.huggingface module+---------------------------------++.. automodule:: camel.datahubs.huggingface+ :members:+ :undoc-members:+ :show-inheritance:++camel.datahubs.models module+----------------------------++.. automodule:: camel.datahubs.models+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.datahubs+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.datasets.rst b/docs/camel.datasets.rstnew file mode 100644index 000000000..d0cdc78a5--- /dev/null+++ b/docs/camel.datasets.rst@@ -0,0 +1,21 @@+camel.datasets package+======================++Submodules+----------++camel.datasets.base module+--------------------------++.. automodule:: camel.datasets.base+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.datasets+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.environments.rst b/docs/camel.environments.rstnew file mode 100644index 000000000..c97ab2ebe--- /dev/null+++ b/docs/camel.environments.rst@@ -0,0 +1,21 @@+camel.environments package+==========================++Submodules+----------++camel.environments.base module+------------------------------++.. automodule:: camel.environments.base+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.environments+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.extractors.rst b/docs/camel.extractors.rstnew file mode 100644index 000000000..b1b23fe82--- /dev/null+++ b/docs/camel.extractors.rst@@ -0,0 +1,21 @@+camel.extractors package+========================++Submodules+----------++camel.extractors.base module+----------------------------++.. automodule:: camel.extractors.base+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.extractors+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.messages.conversion.rst b/docs/camel.messages.conversion.rstnew file mode 100644index 000000000..c4ff84264--- /dev/null+++ b/docs/camel.messages.conversion.rst@@ -0,0 +1,37 @@+camel.messages.conversion package+=================================++Subpackages+-----------++.. toctree::+ :maxdepth: 4++ camel.messages.conversion.sharegpt++Submodules+----------++camel.messages.conversion.alpaca module+---------------------------------------++.. automodule:: camel.messages.conversion.alpaca+ :members:+ :undoc-members:+ :show-inheritance:++camel.messages.conversion.conversation\_models module+-----------------------------------------------------++.. automodule:: camel.messages.conversion.conversation_models+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.messages.conversion+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.messages.conversion.sharegpt.hermes.rst b/docs/camel.messages.conversion.sharegpt.hermes.rstnew file mode 100644index 000000000..57b8f4662--- /dev/null+++ b/docs/camel.messages.conversion.sharegpt.hermes.rst@@ -0,0 +1,21 @@+camel.messages.conversion.sharegpt.hermes package+=================================================++Submodules+----------++camel.messages.conversion.sharegpt.hermes.hermes\_function\_formatter module+----------------------------------------------------------------------------++.. automodule:: camel.messages.conversion.sharegpt.hermes.hermes_function_formatter+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.messages.conversion.sharegpt.hermes+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.messages.conversion.sharegpt.rst b/docs/camel.messages.conversion.sharegpt.rstnew file mode 100644index 000000000..76eb16d5f--- /dev/null+++ b/docs/camel.messages.conversion.sharegpt.rst@@ -0,0 +1,29 @@+camel.messages.conversion.sharegpt package+==========================================++Subpackages+-----------++.. toctree::+ :maxdepth: 4++ camel.messages.conversion.sharegpt.hermes++Submodules+----------++camel.messages.conversion.sharegpt.function\_call\_formatter module+-------------------------------------------------------------------++.. automodule:: camel.messages.conversion.sharegpt.function_call_formatter+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.messages.conversion.sharegpt+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.models.reward.rst b/docs/camel.models.reward.rstnew file mode 100644index 000000000..1a3415935--- /dev/null+++ b/docs/camel.models.reward.rst@@ -0,0 +1,45 @@+camel.models.reward package+===========================++Submodules+----------++camel.models.reward.base\_reward\_model module+----------------------------------------------++.. automodule:: camel.models.reward.base_reward_model+ :members:+ :undoc-members:+ :show-inheritance:++camel.models.reward.evaluator module+------------------------------------++.. automodule:: camel.models.reward.evaluator+ :members:+ :undoc-members:+ :show-inheritance:++camel.models.reward.nemotron\_model module+------------------------------------------++.. automodule:: camel.models.reward.nemotron_model+ :members:+ :undoc-members:+ :show-inheritance:++camel.models.reward.skywork\_model module+-----------------------------------------++.. automodule:: camel.models.reward.skywork_model+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.models.reward+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.personas.rst b/docs/camel.personas.rstnew file mode 100644index 000000000..c4e0918fa--- /dev/null+++ b/docs/camel.personas.rst@@ -0,0 +1,29 @@+camel.personas package+======================++Submodules+----------++camel.personas.persona module+-----------------------------++.. automodule:: camel.personas.persona+ :members:+ :undoc-members:+ :show-inheritance:++camel.personas.persona\_hub module+----------------------------------++.. automodule:: camel.personas.persona_hub+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.personas+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.runtime.rst b/docs/camel.runtime.rstnew file mode 100644index 000000000..2eaf49584--- /dev/null+++ b/docs/camel.runtime.rst@@ -0,0 +1,69 @@+camel.runtime package+=====================++Subpackages+-----------++.. toctree::+ :maxdepth: 4++ camel.runtime.utils++Submodules+----------++camel.runtime.api module+------------------------++.. automodule:: camel.runtime.api+ :members:+ :undoc-members:+ :show-inheritance:++camel.runtime.base module+-------------------------++.. automodule:: camel.runtime.base+ :members:+ :undoc-members:+ :show-inheritance:++camel.runtime.configs module+----------------------------++.. automodule:: camel.runtime.configs+ :members:+ :undoc-members:+ :show-inheritance:++camel.runtime.docker\_runtime module+------------------------------------++.. automodule:: camel.runtime.docker_runtime+ :members:+ :undoc-members:+ :show-inheritance:++camel.runtime.llm\_guard\_runtime module+----------------------------------------++.. automodule:: camel.runtime.llm_guard_runtime+ :members:+ :undoc-members:+ :show-inheritance:++camel.runtime.remote\_http\_runtime module+------------------------------------------++.. automodule:: camel.runtime.remote_http_runtime+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.runtime+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.runtime.utils.rst b/docs/camel.runtime.utils.rstnew file mode 100644index 000000000..4d806d09e--- /dev/null+++ b/docs/camel.runtime.utils.rst@@ -0,0 +1,29 @@+camel.runtime.utils package+===========================++Submodules+----------++camel.runtime.utils.function\_risk\_toolkit module+--------------------------------------------------++.. automodule:: camel.runtime.utils.function_risk_toolkit+ :members:+ :undoc-members:+ :show-inheritance:++camel.runtime.utils.ignore\_risk\_toolkit module+------------------------------------------------++.. automodule:: camel.runtime.utils.ignore_risk_toolkit+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.runtime.utils+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.schemas.rst b/docs/camel.schemas.rstnew file mode 100644index 000000000..d8244437f--- /dev/null+++ b/docs/camel.schemas.rst@@ -0,0 +1,37 @@+camel.schemas package+=====================++Submodules+----------++camel.schemas.base module+-------------------------++.. automodule:: camel.schemas.base+ :members:+ :undoc-members:+ :show-inheritance:++camel.schemas.openai\_converter module+--------------------------------------++.. automodule:: camel.schemas.openai_converter+ :members:+ :undoc-members:+ :show-inheritance:++camel.schemas.outlines\_converter module+----------------------------------------++.. automodule:: camel.schemas.outlines_converter+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.schemas+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.types.agents.rst b/docs/camel.types.agents.rstnew file mode 100644index 000000000..cb1494bb9--- /dev/null+++ b/docs/camel.types.agents.rst@@ -0,0 +1,21 @@+camel.types.agents package+==========================++Submodules+----------++camel.types.agents.tool\_calling\_record module+-----------------------------------------------++.. automodule:: camel.types.agents.tool_calling_record+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.types.agents+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/camel.verifiers.rst b/docs/camel.verifiers.rstnew file mode 100644index 000000000..ff504b36e--- /dev/null+++ b/docs/camel.verifiers.rst@@ -0,0 +1,37 @@+camel.verifiers package+=======================++Submodules+----------++camel.verifiers.base module+---------------------------++.. automodule:: camel.verifiers.base+ :members:+ :undoc-members:+ :show-inheritance:++camel.verifiers.models module+-----------------------------++.. automodule:: camel.verifiers.models+ :members:+ :undoc-members:+ :show-inheritance:++camel.verifiers.python\_verifier module+---------------------------------------++.. automodule:: camel.verifiers.python_verifier+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: camel.verifiers+ :members:+ :undoc-members:+ :show-inheritance:diff --git a/docs/cookbooks/data_generation/synthetic_dataevaluation&filter_with_reward_model.ipynb b/docs/cookbooks/data_generation/synthetic_dataevaluation&filter_with_reward_model.ipynbindex 8844934a8..fa3616219 100644--- a/docs/cookbooks/data_generation/synthetic_dataevaluation&filter_with_reward_model.ipynb+++ b/docs/cookbooks/data_generation/synthetic_dataevaluation&filter_with_reward_model.ipynb@@ -368,7 +368,7 @@"id": "hIuE1dImfBJG"},"source": [- "# ✨Test Reward Model\n",+ "## ✨Test Reward Model\n","Then, we can test the reward model to check its output format and use it as a reference to set the filtering criteria.\n"]},diff --git a/docs/images/workforce2.png b/docs/images/workforce2.pngnew file mode 100644index 000000000..31b230cb1Binary files /dev/null and b/docs/images/workforce2.png differ