-
Notifications
You must be signed in to change notification settings - Fork 731
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 71c234957f4f653d9822dccd4f08b46a | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
docs.camel-ai.org |
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# How to update the documentation | ||
|
||
To update the RST files: | ||
```bash | ||
sphinx-apidoc -o docs camel/ | ||
``` | ||
|
||
Helpful article [here](https://towardsdatascience.com/documenting-python-code-with-sphinx-554e1d6c4f6d). | ||
|
||
# Building Documentation | ||
|
||
To build the documentation: | ||
|
||
1. [Install CAMEL](https://github.com/camel-ai/camel/blob/master/README.md) from source. | ||
|
||
2. Install required dependencies running the following command in your terminal or command prompt: | ||
```bash | ||
pip install sphinx | ||
pip install sphinx_book_theme | ||
pip install sphinx-autobuild | ||
pip install myst_parser | ||
pip install nbsphinx | ||
``` | ||
|
||
3. Build the document and launch the HTML documentation. | ||
```bash | ||
cd docs | ||
sphinx-autobuild . _build/html --port 8000 | ||
``` | ||
|
||
This command starts a local HTTP server on port 8080 by default. Once the server is running, open your web browser and enter the following URL: | ||
```bash | ||
127.0.0.1:8000 | ||
``` | ||
This will load the HTML documentation in your web browser from the local server. The server will watch for changes in your source files and automatically rebuild the documentation and refresh the page in the browser when you make changes – so changes in docs will be immediately reflected in the rendered doc. | ||
|
||
You can navigate through the documentation using the links and interact with it as you would with any other web page. | ||
|
||
To stop the local server, go back to the terminal or command prompt where it is running and press `Ctrl+C` to terminate the server. | ||
|
||
In case the autobuild does not work, you may use the traditional build approach: | ||
```bash | ||
cd docs | ||
make html | ||
cd _build/html | ||
python -m http.server | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
camel.agents package | ||
==================== | ||
|
||
Subpackages | ||
----------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
camel.agents.tool_agents | ||
|
||
Submodules | ||
---------- | ||
|
||
camel.agents.base module | ||
------------------------ | ||
|
||
.. automodule:: camel.agents.base | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.agents.chat\_agent module | ||
------------------------------- | ||
|
||
.. automodule:: camel.agents.chat_agent | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.agents.critic\_agent module | ||
--------------------------------- | ||
|
||
.. automodule:: camel.agents.critic_agent | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.agents.deductive\_reasoner\_agent module | ||
---------------------------------------------- | ||
|
||
.. automodule:: camel.agents.deductive_reasoner_agent | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.agents.embodied\_agent module | ||
----------------------------------- | ||
|
||
.. automodule:: camel.agents.embodied_agent | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.agents.knowledge\_graph\_agent module | ||
------------------------------------------- | ||
|
||
.. automodule:: camel.agents.knowledge_graph_agent | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.agents.role\_assignment\_agent module | ||
------------------------------------------- | ||
|
||
.. automodule:: camel.agents.role_assignment_agent | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.agents.search\_agent module | ||
--------------------------------- | ||
|
||
.. automodule:: camel.agents.search_agent | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.agents.task\_agent module | ||
------------------------------- | ||
|
||
.. automodule:: camel.agents.task_agent | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: camel.agents | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
camel.agents.tool\_agents package | ||
================================= | ||
|
||
Submodules | ||
---------- | ||
|
||
camel.agents.tool\_agents.base module | ||
------------------------------------- | ||
|
||
.. automodule:: camel.agents.tool_agents.base | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.agents.tool\_agents.hugging\_face\_tool\_agent module | ||
----------------------------------------------------------- | ||
|
||
.. automodule:: camel.agents.tool_agents.hugging_face_tool_agent | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: camel.agents.tool_agents | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
camel.configs package | ||
===================== | ||
|
||
Submodules | ||
---------- | ||
|
||
camel.configs.anthropic\_config module | ||
-------------------------------------- | ||
|
||
.. automodule:: camel.configs.anthropic_config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.configs.base\_config module | ||
--------------------------------- | ||
|
||
.. automodule:: camel.configs.base_config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.configs.gemini\_config module | ||
----------------------------------- | ||
|
||
.. automodule:: camel.configs.gemini_config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.configs.groq\_config module | ||
--------------------------------- | ||
|
||
.. automodule:: camel.configs.groq_config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.configs.litellm\_config module | ||
------------------------------------ | ||
|
||
.. automodule:: camel.configs.litellm_config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.configs.mistral\_config module | ||
------------------------------------ | ||
|
||
.. automodule:: camel.configs.mistral_config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.configs.ollama\_config module | ||
----------------------------------- | ||
|
||
.. automodule:: camel.configs.ollama_config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.configs.openai\_config module | ||
----------------------------------- | ||
|
||
.. automodule:: camel.configs.openai_config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.configs.reka\_config module | ||
--------------------------------- | ||
|
||
.. automodule:: camel.configs.reka_config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.configs.samba\_config module | ||
---------------------------------- | ||
|
||
.. automodule:: camel.configs.samba_config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.configs.togetherai\_config module | ||
--------------------------------------- | ||
|
||
.. automodule:: camel.configs.togetherai_config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.configs.vllm\_config module | ||
--------------------------------- | ||
|
||
.. automodule:: camel.configs.vllm_config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.configs.zhipuai\_config module | ||
------------------------------------ | ||
|
||
.. automodule:: camel.configs.zhipuai_config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: camel.configs | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
camel.embeddings package | ||
======================== | ||
|
||
Submodules | ||
---------- | ||
|
||
camel.embeddings.base module | ||
---------------------------- | ||
|
||
.. automodule:: camel.embeddings.base | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.embeddings.mistral\_embedding module | ||
------------------------------------------ | ||
|
||
.. automodule:: camel.embeddings.mistral_embedding | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.embeddings.openai\_embedding module | ||
----------------------------------------- | ||
|
||
.. automodule:: camel.embeddings.openai_embedding | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.embeddings.sentence\_transformers\_embeddings module | ||
---------------------------------------------------------- | ||
|
||
.. automodule:: camel.embeddings.sentence_transformers_embeddings | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
camel.embeddings.vlm\_embedding module | ||
-------------------------------------- | ||
|
||
.. automodule:: camel.embeddings.vlm_embedding | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: camel.embeddings | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |