From 3c1e0fa5120b849900b1e459f6f11597bd438393 Mon Sep 17 00:00:00 2001
From: Hamed Babaei Giglou <hamedbabaeigiglou@gmail.com>
Date: Sun, 8 Dec 2024 08:46:47 +0100
Subject: [PATCH] :memo: ICV and ontology matchers docs

---
 docs/source/index.rst                         |  1 +
 .../package_reference/ontolog_matchers.rst    | 94 +++++++++++++++++++
 docs/source/tutorials/rag.rst                 |  4 +-
 3 files changed, 97 insertions(+), 2 deletions(-)
 create mode 100644 docs/source/package_reference/ontolog_matchers.rst

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 2fbeaa5..1df680b 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -53,6 +53,7 @@ OntoAligner Documentation
 
    package_reference/base
    package_reference/ontology
+   package_reference/ontolog_matchers
    package_reference/encoder
    package_reference/postprocess
    package_reference/utils
diff --git a/docs/source/package_reference/ontolog_matchers.rst b/docs/source/package_reference/ontolog_matchers.rst
new file mode 100644
index 0000000..31a3fa8
--- /dev/null
+++ b/docs/source/package_reference/ontolog_matchers.rst
@@ -0,0 +1,94 @@
+Ontology Matchers
+====================
+
+
+
+Lightweight
+------------------
+.. automodule:: ontoaligner.ontology_matchers.lightweight
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Lightweight Models
+------------------
+.. automodule:: ontoaligner.ontology_matchers.lightweight.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Retrieval
+------------------
+.. automodule:: ontoaligner.ontology_matchers.retrieval.retrieval
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Retrieval Models
+------------------
+.. automodule:: ontoaligner.ontology_matchers.retrieval.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+LLM
+-------------
+.. automodule:: ontoaligner.ontology_matchers.llm.llm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+LLM Models
+------------------
+.. automodule:: ontoaligner.ontology_matchers.llm.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+RAG
+-------------
+.. automodule:: ontoaligner.ontology_matchers.rag.rag
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+RAG Models
+------------------
+.. automodule:: ontoaligner.ontology_matchers.rag.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+
+FewShotRAG
+-------------
+.. automodule:: ontoaligner.ontology_matchers.fewshot.fewshot
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+FewShotRAG Models
+------------------
+.. automodule:: ontoaligner.ontology_matchers.fewshot.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+
+ICV RAG
+-------------
+.. automodule:: ontoaligner.ontology_matchers.icv.icv
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ICVRAG Models
+------------------
+.. automodule:: ontoaligner.ontology_matchers.rag.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/tutorials/rag.rst b/docs/source/tutorials/rag.rst
index 7a86d77..c4aee53 100644
--- a/docs/source/tutorials/rag.rst
+++ b/docs/source/tutorials/rag.rst
@@ -96,7 +96,7 @@ This tutorial works based on FewShot RAG matching, an extension of the RAG model
 
 In-Context Vectors RAG
 ==================================
-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:
+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:
 
 
 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
     model.load(llm_path="tiiuae/falcon-7b", ir_path="all-MiniLM-L6-v2")
 
 
-[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.
+[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.