Skip to content

Commit dc7dfe2

Browse files
committed
📝 update kge docs
1 parent 5f5fe5d commit dc7dfe2

File tree

2 files changed

+29
-27
lines changed

2 files changed

+29
-27
lines changed

docs/source/aligner/kge.rst

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ Knowledge Graph Embedding
44
Graph Embeddings
55
---------------------------------
66

7+
.. sidebar:: **Reference:**
8+
9+
`OntoAligner Meets Knowledge Graph Embedding Aligners <https://arxiv.org/abs/2509.26417>`_
10+
11+
712
Ontology alignment involves finding correspondences between entities in different ontologies. OntoAligner addresses this challenge by leveraging **Knowledge Graph Embedding (KGE)** models. The core idea of KGE is to represent entities (like classes, properties, individuals) and relations within an ontology as **low-dimensional vectors** in a continuous vector space. These numerical representations (embeddings) are learned to preserve semantic relationships from the original ontology geometrically in the embedding space.
813

914
.. hint::
@@ -285,21 +290,6 @@ Here is the example on how to use KGE Aligner as a retriever model:
285290
286291
matchings = aligner.generate(input_data=encoded_dataset)
287292
288-
# Example output:
289-
# [
290-
# {
291-
# "source": "http://mouse.owl#MA_0000143",
292-
# "target-cands": [
293-
# "http://human.owl#HBA_0000214",
294-
# "http://human.owl#HBA_0000762",
295-
# "http://human.owl#HBA_0000891"
296-
# ],
297-
# "score-cands": [0.87, 0.82, 0.77]
298-
# },
299-
# ...
300-
# ]
301-
302-
303293
.. list-table::
304294
:widths: 20 80
305295
:header-rows: 1
@@ -309,26 +299,31 @@ Here is the example on how to use KGE Aligner as a retriever model:
309299

310300
* - **KGE Default mode**
311301
- In KGE aligners, the default mode is ``retriever=False``, where it produces **one-to-one** alignments, where each source entity is matched to the single most similar target entity.
312-
313-
314302
* - **KGE Retriever mode**
315-
- In KGE aligners, the default mode is ``retriever=True``, where it produces **one-to-many** alignments, where each source entity is matched to the single most similar target entity. Example output:
303+
- In KGE aligners, the default mode is ``retriever=True``, where it produces **one-to-many** alignments, where each source entity is matched to multiple target entities. Example output:
316304

317305

318306

319-
.. tab:: ➡️ KGE Default Mode Example output
307+
.. tab:: ➡️ KGE Retriever Mode Example output
320308

321-
::
309+
::
322310

323-
{
324-
'source': 'http://mouse.owl#MA_0000143',
325-
'target-cands': [...],
326-
'score-cands': [...]
327-
}
311+
[
312+
{
313+
"source": "http://mouse.owl#MA_0000143",
314+
"target-cands": [
315+
"http://human.owl#HBA_0000214",
316+
"http://human.owl#HBA_0000762",
317+
"http://human.owl#HBA_0000891"
318+
],
319+
"score-cands": [0.87, 0.82, 0.77]
320+
},
321+
...
322+
]
328323

329324

330325

331-
.. tab:: ➡️ KGE Retriever Mode Example output
326+
.. tab:: ➡️ KGE Default Mode Example output
332327

333328
::
334329

@@ -337,3 +332,10 @@ Here is the example on how to use KGE Aligner as a retriever model:
337332
'target': 'http://human.owl#HBA_0000214',
338333
'score': 0.87
339334
}
335+
336+
337+
.. note::
338+
339+
Consider reading the following section next:
340+
341+
* `Package Reference > Aligners <../package_reference/aligners.html>`_

docs/source/package_reference/aligners.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ KGE Aligners
6363
:members:
6464
:undoc-members:
6565
:show-inheritance:
66-
:special-members:
66+
:special-members: __init__, generate

0 commit comments

Comments
 (0)