Skip to content

Commit f6c1570

Browse files
committed
📝 cosmetic fix to readme
1 parent 93d446a commit f6c1570

File tree

1 file changed

+48
-18
lines changed

1 file changed

+48
-18
lines changed

README.md

Lines changed: 48 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
<img src="https://raw.githubusercontent.com/sciknoworg/OntoAligner/main/images/logo-with-background.png" alt="OntoAligner Logo"/>
33
</div>
44

5-
<h3 align="center">OntoAligner: A Comprehensive Modular and Robust Python Toolkit for Ontology Alignment</h3>
6-
75
<div align="center">
86

97
[![PyPI version](https://badge.fury.io/py/OntoAligner.svg)](https://badge.fury.io/py/OntoAligner)
@@ -12,9 +10,12 @@
1210
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
1311
[![Documentation Status](https://readthedocs.org/projects/ontoaligner/badge/?version=main)](https://ontoaligner.readthedocs.io/)
1412
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](MAINTANANCE.md)
13+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14533133.svg)](https://doi.org/10.5281/zenodo.14533133)
1514

1615
</div>
1716

17+
<h3 align="center">OntoAligner: A Comprehensive Modular and Robust Python Toolkit for Ontology Alignment</h3>
18+
1819
**OntoAligner** is a Python library designed to simplify ontology alignment and matching for researchers, practitioners, and developers. With a modular architecture and robust features, OntoAligner provides powerful tools to bridge ontologies effectively.
1920

2021

@@ -85,7 +86,7 @@ encoder_model = ConceptParentRAGEncoder()
8586
encoded_ontology = encoder_model(source=dataset['source'], target=dataset['target'])
8687

8788
# Step 4: Define configuration for retriever and LLM
88-
retriever_config = {"device": 'cuda', "top_k": 5,}
89+
retriever_config = {"device": 'cuda', "top_k": 5}
8990
llm_config = {"device": "cuda", "max_length": 300, "max_new_tokens": 10, "batch_size": 15}
9091

9192
# Step 5: Initialize Generate predictions using RAG-based ontology matcher
@@ -115,7 +116,7 @@ pipeline = ontoaligner.OntoAlignerPipeline(
115116
task_class=ontoaligner.ontology.MouseHumanOMDataset,
116117
source_ontology_path="assets/MI-MatOnto/mi_ontology.xml",
117118
target_ontology_path="assets/MI-MatOnto/matonto_ontology.xml",
118-
reference_matching_path="assets/MI-MatOnto/matchings.xml",
119+
reference_matching_path="assets/MI-MatOnto/matchings.xml"
119120
)
120121

121122
matchings, evaluation = pipeline(
@@ -138,27 +139,56 @@ matchings, evaluation = pipeline(
138139

139140
print("Matching Evaluation Report:", evaluation)
140141
```
141-
## ⭐ Contribution
142+
## 👥 Contact & Contributions
142143

143144
We welcome contributions to enhance OntoAligner and make it even better! Please review our contribution guidelines in [CONTRIBUTING.md](CONTRIBUTING.md) before getting started. You are also welcome to assist with the ongoing maintenance by referring to [MAINTENANCE.md](MAINTENANCE.md). Your support is greatly appreciated.
144145

145146

146147
If you encounter any issues or have questions, please submit them in the [GitHub issues tracker](https://github.com/sciknoworg/OntoAligner/issues).
147148

148149

149-
## 💡 Acknowledgements
150+
## 📚 Citing this Work
150151

151152
If you use OntoAligner in your work or research, please cite the following preprint:
152153

153-
```bibtex
154-
@inproceedings{babaei2025ontoaligner,
155-
title={OntoAligner: A Comprehensive Modular and Robust Python Toolkit for Ontology Alignment},
156-
author={Babaei Giglou, Hamed and D’Souza, Jennifer and Karras, Oliver and Auer, S{\"o}ren},
157-
booktitle={European Semantic Web Conference},
158-
pages={174--191},
159-
year={2025},
160-
organization={Springer}
161-
}
162-
```
163-
164-
This software is archived in Zenodo under the DOI [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14533133.svg)](https://doi.org/10.5281/zenodo.14533133) and is licensed under [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0).
154+
- OntoAligner Library:
155+
> Babaei Giglou, H., D’Souza, J., Karras, O., Auer, S. (2025). OntoAligner: A Comprehensive Modular and Robust Python Toolkit for Ontology Alignment. In: Curry, E., et al. The Semantic Web. ESWC 2025. Lecture Notes in Computer Science, vol 15719. Springer, Cham. https://doi.org/10.1007/978-3-031-94578-6_10
156+
157+
📌 BibTeX
158+
```bibtex
159+
@InProceedings{10.1007/978-3-031-94578-6_10,
160+
author="Babaei Giglou, Hamed and D'Souza, Jennifer and Karras, Oliver and Auer, S{\"o}ren",
161+
editor="Curry, Edward and Acosta, Maribel and Poveda-Villal{\'o}n, Maria and van Erp, Marieke and Ojo, Adegboyega and Hose, Katja and Shimizu, Cogan and Lisena, Pasquale",
162+
title="OntoAligner: A Comprehensive Modular and Robust Python Toolkit for Ontology Alignment",
163+
booktitle="The Semantic Web",
164+
year="2025",
165+
publisher="Springer Nature Switzerland",
166+
address="Cham",
167+
pages="174--191"
168+
}
169+
```
170+
171+
- LLMs4OM (for RAG module)
172+
> Babaei Giglou, H., D’Souza, J., Engel, F., Auer, S. (2025). LLMs4OM: Matching Ontologies with Large Language Models. In: Meroño Peñuela, A., et al. The Semantic Web: ESWC 2024 Satellite Events. ESWC 2024. Lecture Notes in Computer Science, vol 15344. Springer, Cham. https://doi.org/10.1007/978-3-031-78952-6_3
173+
174+
📌 BibTeX
175+
```bibtex
176+
@InProceedings{10.1007/978-3-031-78952-6_3,
177+
author="Babaei Giglou, Hamed and D'Souza, Jennifer and Engel, Felix and Auer, S{\"o}ren",
178+
editor="Mero{\~{n}}o Pe{\~{n}}uela, Albert and Corcho, Oscar and Groth, Paul and Simperl, Elena and Tamma, Valentina and Nuzzolese, Andrea Giovanni and Poveda-Villal{\'o}n, Maria and Sabou, Marta and Presutti, Valentina and Celino, Irene and Revenko, Artem and Raad, Joe and Sartini, Bruno and Lisena, Pasquale",
179+
title="LLMs4OM: Matching Ontologies with Large Language Models",
180+
booktitle="The Semantic Web: ESWC 2024 Satellite Events",
181+
year="2025",
182+
publisher="Springer Nature Switzerland",
183+
address="Cham",
184+
pages="25--35",
185+
isbn="978-3-031-78952-6"
186+
}
187+
```
188+
189+
## 📃 License
190+
191+
This software is licensed under [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0).
192+
193+
[//]: # (This work is licensed under a MIT License)
194+
[//]: # (is archived in Zenodo under the DOI [![DOI]&#40;https://zenodo.org/badge/DOI/10.5281/zenodo.14533133.svg&#41;]&#40;https://doi.org/10.5281/zenodo.14533133&#41; and )

0 commit comments

Comments
 (0)