Skip to content

Commit 3c1e0fa

Browse files
committed
📝 ICV and ontology matchers docs
1 parent f3c76ea commit 3c1e0fa

File tree

3 files changed

+97
-2
lines changed

3 files changed

+97
-2
lines changed

Diff for: docs/source/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ OntoAligner Documentation
5353

5454
package_reference/base
5555
package_reference/ontology
56+
package_reference/ontolog_matchers
5657
package_reference/encoder
5758
package_reference/postprocess
5859
package_reference/utils

Diff for: docs/source/package_reference/ontolog_matchers.rst

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
Ontology Matchers
2+
====================
3+
4+
5+
6+
Lightweight
7+
------------------
8+
.. automodule:: ontoaligner.ontology_matchers.lightweight
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
13+
Lightweight Models
14+
------------------
15+
.. automodule:: ontoaligner.ontology_matchers.lightweight.models
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
Retrieval
21+
------------------
22+
.. automodule:: ontoaligner.ontology_matchers.retrieval.retrieval
23+
:members:
24+
:undoc-members:
25+
:show-inheritance:
26+
27+
Retrieval Models
28+
------------------
29+
.. automodule:: ontoaligner.ontology_matchers.retrieval.models
30+
:members:
31+
:undoc-members:
32+
:show-inheritance:
33+
34+
35+
LLM
36+
-------------
37+
.. automodule:: ontoaligner.ontology_matchers.llm.llm
38+
:members:
39+
:undoc-members:
40+
:show-inheritance:
41+
42+
LLM Models
43+
------------------
44+
.. automodule:: ontoaligner.ontology_matchers.llm.models
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:
48+
49+
50+
RAG
51+
-------------
52+
.. automodule:: ontoaligner.ontology_matchers.rag.rag
53+
:members:
54+
:undoc-members:
55+
:show-inheritance:
56+
57+
RAG Models
58+
------------------
59+
.. automodule:: ontoaligner.ontology_matchers.rag.models
60+
:members:
61+
:undoc-members:
62+
:show-inheritance:
63+
64+
65+
66+
FewShotRAG
67+
-------------
68+
.. automodule:: ontoaligner.ontology_matchers.fewshot.fewshot
69+
:members:
70+
:undoc-members:
71+
:show-inheritance:
72+
73+
FewShotRAG Models
74+
------------------
75+
.. automodule:: ontoaligner.ontology_matchers.fewshot.models
76+
:members:
77+
:undoc-members:
78+
:show-inheritance:
79+
80+
81+
82+
ICV RAG
83+
-------------
84+
.. automodule:: ontoaligner.ontology_matchers.icv.icv
85+
:members:
86+
:undoc-members:
87+
:show-inheritance:
88+
89+
ICVRAG Models
90+
------------------
91+
.. automodule:: ontoaligner.ontology_matchers.rag.models
92+
:members:
93+
:undoc-members:
94+
:show-inheritance:

Diff for: docs/source/tutorials/rag.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ This tutorial works based on FewShot RAG matching, an extension of the RAG model
9696
9797
In-Context Vectors RAG
9898
==================================
99-
This RAG variant performs ontology matching using ``ConceptRAGEncoder`` only. The In-Contect Vectors introduced by `[1]<https://github.com/shengliu66/ICV>`_ tackle in-context learning as in-context vectors (ICV). We used LLMs in this perspective in the RAG module. The workflow is the same as RAG or FewShot RAG with the following differences:
99+
This RAG variant performs ontology matching using ``ConceptRAGEncoder`` only. The In-Contect Vectors introduced by [1](https://github.com/shengliu66/ICV) tackle in-context learning as in-context vectors (ICV). We used LLMs in this perspective in the RAG module. The workflow is the same as RAG or FewShot RAG with the following differences:
100100

101101

102102
1. Incorporate the ``ConceptRAGEncoder`` and also provide reference (or examples to build up the ICV vectors).
@@ -117,4 +117,4 @@ This RAG variant performs ontology matching using ``ConceptRAGEncoder`` only. Th
117117
model.load(llm_path="tiiuae/falcon-7b", ir_path="all-MiniLM-L6-v2")
118118
119119
120-
[1] Liu, S., Ye, H., Xing, L., & Zou, J. (2023). `In-context vectors: Making in context learning more effective and controllable through latent space steering<https://arxiv.org/abs/2311.06668>`_. arXiv preprint arXiv:2311.06668.
120+
[1] Liu, S., Ye, H., Xing, L., & Zou, J. (2023). [In-context vectors: Making in context learning more effective and controllable through latent space steering](https://arxiv.org/abs/2311.06668>). arXiv preprint arXiv:2311.06668.

0 commit comments

Comments
 (0)