Skip to content

Commit 4eba8c2

Browse files
committed
📝 docs(api): update module names and add new section
- rename "core.embed" to "core.embeddings" for clarity - add documentation for "core.types" module - remove outdated sections in "retrieval" related to siliconflow modules
1 parent e3b9291 commit 4eba8c2

File tree

2 files changed

+11
-19
lines changed

2 files changed

+11
-19
lines changed

docs/source/api/core.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ core.basics module
1212
:undoc-members:
1313
:show-inheritance:
1414

15-
core.embed module
16-
-----------------
15+
core.embeddings module
16+
----------------------
1717

18-
.. automodule:: core.embed
18+
.. automodule:: core.embeddings
1919
:members:
2020
:undoc-members:
2121
:show-inheritance:
@@ -36,6 +36,14 @@ core.rerank module
3636
:undoc-members:
3737
:show-inheritance:
3838

39+
core.types module
40+
-----------------
41+
42+
.. automodule:: core.types
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
3947
core.utils module
4048
-----------------
4149

docs/source/api/retrieval.rst

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,6 @@ retrieval.pgvector\_store module
2020
:undoc-members:
2121
:show-inheritance:
2222

23-
retrieval.siliconflow\_embeddings module
24-
----------------------------------------
25-
26-
.. automodule:: retrieval.siliconflow_embeddings
27-
:members:
28-
:undoc-members:
29-
:show-inheritance:
30-
31-
retrieval.siliconflow\_rerank module
32-
------------------------------------
33-
34-
.. automodule:: retrieval.siliconflow_rerank
35-
:members:
36-
:undoc-members:
37-
:show-inheritance:
38-
3923
retrieval.sqlitevec\_store module
4024
---------------------------------
4125

0 commit comments

Comments
 (0)