Skip to content

Commit 0243737

Browse files
authored
docs: Update doc (camel-ai#1743)
1 parent 3c86269 commit 0243737

25 files changed

+798
-1
lines changed

docs/camel.benchmarks.rst

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
camel.benchmarks package
2+
========================
3+
4+
Submodules
5+
----------
6+
7+
camel.benchmarks.apibank module
8+
-------------------------------
9+
10+
.. automodule:: camel.benchmarks.apibank
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
camel.benchmarks.apibench module
16+
--------------------------------
17+
18+
.. automodule:: camel.benchmarks.apibench
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
camel.benchmarks.base module
24+
----------------------------
25+
26+
.. automodule:: camel.benchmarks.base
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
camel.benchmarks.gaia module
32+
----------------------------
33+
34+
.. automodule:: camel.benchmarks.gaia
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
camel.benchmarks.nexus module
40+
-----------------------------
41+
42+
.. automodule:: camel.benchmarks.nexus
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
camel.benchmarks.ragbench module
48+
--------------------------------
49+
50+
.. automodule:: camel.benchmarks.ragbench
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
Module contents
56+
---------------
57+
58+
.. automodule:: camel.benchmarks
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:

docs/camel.bots.discord.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
camel.bots.discord package
2+
==========================
3+
4+
Submodules
5+
----------
6+
7+
camel.bots.discord.discord\_app module
8+
--------------------------------------
9+
10+
.. automodule:: camel.bots.discord.discord_app
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
camel.bots.discord.discord\_installation module
16+
-----------------------------------------------
17+
18+
.. automodule:: camel.bots.discord.discord_installation
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
camel.bots.discord.discord\_store module
24+
----------------------------------------
25+
26+
.. automodule:: camel.bots.discord.discord_store
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: camel.bots.discord
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

docs/camel.bots.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
camel.bots package
2+
==================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
camel.bots.discord
11+
camel.bots.slack
12+
13+
Submodules
14+
----------
15+
16+
camel.bots.telegram\_bot module
17+
-------------------------------
18+
19+
.. automodule:: camel.bots.telegram_bot
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
Module contents
25+
---------------
26+
27+
.. automodule:: camel.bots
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:

docs/camel.bots.slack.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
camel.bots.slack package
2+
========================
3+
4+
Submodules
5+
----------
6+
7+
camel.bots.slack.models module
8+
------------------------------
9+
10+
.. automodule:: camel.bots.slack.models
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
camel.bots.slack.slack\_app module
16+
----------------------------------
17+
18+
.. automodule:: camel.bots.slack.slack_app
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: camel.bots.slack
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

docs/camel.data_collector.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
camel.data\_collector package
2+
=============================
3+
4+
Submodules
5+
----------
6+
7+
camel.data\_collector.alpaca\_collector module
8+
----------------------------------------------
9+
10+
.. automodule:: camel.data_collector.alpaca_collector
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
camel.data\_collector.base module
16+
---------------------------------
17+
18+
.. automodule:: camel.data_collector.base
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
camel.data\_collector.sharegpt\_collector module
24+
------------------------------------------------
25+
26+
.. automodule:: camel.data_collector.sharegpt_collector
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: camel.data_collector
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

docs/camel.datagen.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
camel.datagen package
2+
=====================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
camel.datagen.self_instruct
11+
camel.datagen.source2synth
12+
13+
Submodules
14+
----------
15+
16+
camel.datagen.cot\_datagen module
17+
---------------------------------
18+
19+
.. automodule:: camel.datagen.cot_datagen
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
camel.datagen.self\_improving\_cot module
25+
-----------------------------------------
26+
27+
.. automodule:: camel.datagen.self_improving_cot
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:
31+
32+
Module contents
33+
---------------
34+
35+
.. automodule:: camel.datagen
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
camel.datagen.self\_instruct.filter package
2+
===========================================
3+
4+
Submodules
5+
----------
6+
7+
camel.datagen.self\_instruct.filter.filter\_function module
8+
-----------------------------------------------------------
9+
10+
.. automodule:: camel.datagen.self_instruct.filter.filter_function
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
camel.datagen.self\_instruct.filter.filter\_registry module
16+
-----------------------------------------------------------
17+
18+
.. automodule:: camel.datagen.self_instruct.filter.filter_registry
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
camel.datagen.self\_instruct.filter.instruction\_filter module
24+
--------------------------------------------------------------
25+
26+
.. automodule:: camel.datagen.self_instruct.filter.instruction_filter
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: camel.datagen.self_instruct.filter
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
camel.datagen.self\_instruct package
2+
====================================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
camel.datagen.self_instruct.filter
11+
12+
Submodules
13+
----------
14+
15+
camel.datagen.self\_instruct.self\_instruct module
16+
--------------------------------------------------
17+
18+
.. automodule:: camel.datagen.self_instruct.self_instruct
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
camel.datagen.self\_instruct.templates module
24+
---------------------------------------------
25+
26+
.. automodule:: camel.datagen.self_instruct.templates
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: camel.datagen.self_instruct
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
camel.datagen.source2synth package
2+
==================================
3+
4+
Submodules
5+
----------
6+
7+
camel.datagen.source2synth.data\_processor module
8+
-------------------------------------------------
9+
10+
.. automodule:: camel.datagen.source2synth.data_processor
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
camel.datagen.source2synth.models module
16+
----------------------------------------
17+
18+
.. automodule:: camel.datagen.source2synth.models
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
camel.datagen.source2synth.user\_data\_processor\_config module
24+
---------------------------------------------------------------
25+
26+
.. automodule:: camel.datagen.source2synth.user_data_processor_config
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: camel.datagen.source2synth
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

docs/camel.datahubs.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
camel.datahubs package
2+
======================
3+
4+
Submodules
5+
----------
6+
7+
camel.datahubs.base module
8+
--------------------------
9+
10+
.. automodule:: camel.datahubs.base
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
camel.datahubs.huggingface module
16+
---------------------------------
17+
18+
.. automodule:: camel.datahubs.huggingface
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
camel.datahubs.models module
24+
----------------------------
25+
26+
.. automodule:: camel.datahubs.models
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: camel.datahubs
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

0 commit comments

Comments
 (0)