Skip to content

Commit eeeb578

Browse files
HamedBabaeiHamedBabaei
authored
Merge pull request #31 from sciknoworg/dev
add test automation
2 parents 8698c36 + 55f348d commit eeeb578

File tree

7 files changed

+66
-27
lines changed

7 files changed

+66
-27
lines changed

‎.github/workflows/test-package.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Test OntoAligner Package
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
build-and-test:
11+
runs-on: ubuntu-latest
12+
13+
strategy:
14+
matrix:
15+
python-version: [3.10.x, 3.11.x]
16+
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v3
20+
21+
- name: Set up Python ${{ matrix.python-version }}
22+
uses: actions/setup-python@v4
23+
with:
24+
python-version: ${{ matrix.python-version }}
25+
26+
- name: Install Poetry
27+
run: |
28+
curl -sSL https://install.python-poetry.org | python3 -
29+
echo "$HOME/.local/bin" >> $GITHUB_PATH
30+
31+
- name: Configure Poetry and install dependencies
32+
run: |
33+
poetry config virtualenvs.create false
34+
poetry install --no-interaction --with dev
35+
36+
- name: Run tests
37+
run: |
38+
poetry run pytest

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ develop-eggs/
1717
dist/
1818
downloads/
1919
eggs/
20+
testenv/
2021
.eggs/
2122
lib/
2223
lib64/

‎README.md‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,19 @@ pip install ./ontoaligner
3535

3636
## 📚 Documentation
3737

38-
Comprehensive documentation for OntoAligner, including detailed guides and examples, is available at **[ontoaligner.readthedocs.io](https://ontoaligner.readthedocs.io/)**.
38+
Comprehensive documentation for OntoAligner, including detailed guides and examples, is available at **[ontoaligner.readthedocs.io](https://ontoaligner.readthedocs.io/)**. Below are some key tutorials with links to both the documentation and the corresponding example codes.
3939

40-
**Tutorials**
4140

42-
| Example | Tutorial | Script |
43-
|:-------------------------------|:----------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------:|
44-
| Lightweight | [📚 Fuzzy Matching](https://ontoaligner.readthedocs.io/tutorials/lightweight.html) | [📝 Code](https://github.com/sciknoworg/OntoAligner/blob/main/examples/fuzzy_matching.py) |
45-
| Retrieval | [📚 Retrieval Aligner](https://ontoaligner.readthedocs.io/tutorials/retriever.html) | [📝 Code](https://github.com/sciknoworg/OntoAligner/blob/main/examples/retriever_matching.py) |
46-
| Large Language Models | [📚 Large Language Models Aligner](https://ontoaligner.readthedocs.io/tutorials/llm.html) | [📝 Code](https://github.com/sciknoworg/OntoAligner/blob/main/examples/llm_matching.py) |
47-
| Retrieval Augmented Generation | [📚 Retrieval Augmented Generation](https://ontoaligner.readthedocs.io/tutorials/rag.html) | [📝 Code](https://github.com/sciknoworg/OntoAligner/blob/main/examples/rag_matching.py)|
48-
| FewShot | [📚 FewShot RAG](https://ontoaligner.readthedocs.io/tutorials/rag.html#fewshot-rag) | [📝 Code](https://github.com/sciknoworg/OntoAligner/blob/main/examples/rag_matching.py)
49-
| In-Context Vectors Learning | [📚 In-Context Vectors RAG](https://ontoaligner.readthedocs.io/tutorials/rag.html#in-context-vectors-rag) | [📝 Code](https://github.com/sciknoworg/OntoAligner/blob/main/examples/icv_rag_matching.py)
41+
42+
| Example | Tutorial | Script |
43+
|:----------------------------------------|:--------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------:|
44+
| Lightweight | [📚 Fuzzy Matching](https://ontoaligner.readthedocs.io/aligner/lightweight.html) | [📝 Code](https://github.com/sciknoworg/OntoAligner/blob/main/examples/fuzzy_matching.py) |
45+
| Retrieval | [📚 Retrieval Aligner](https://ontoaligner.readthedocs.io/aligner/retriever.html) | [📝 Code](https://github.com/sciknoworg/OntoAligner/blob/main/examples/retriever_matching.py) |
46+
| Large Language Models | [📚 Large Language Models Aligner](https://ontoaligner.readthedocs.io/aligner/llm.html) | [📝 Code](https://github.com/sciknoworg/OntoAligner/blob/main/examples/llm_matching.py) |
47+
| Retrieval Augmented Generation | [📚 Retrieval Augmented Generation](https://ontoaligner.readthedocs.io/aligner/rag.html) | [📝 Code](https://github.com/sciknoworg/OntoAligner/blob/main/examples/rag_matching.py)|
48+
| FewShot | [📚 FewShot RAG](https://ontoaligner.readthedocs.io/aligner/rag.html#fewshot-rag) | [📝 Code](https://github.com/sciknoworg/OntoAligner/blob/main/examples/rag_matching.py)
49+
| In-Context Vectors Learning | [📚 In-Context Vectors RAG](https://ontoaligner.readthedocs.io/aligner/rag.html#in-context-vectors-rag) | [📝 Code](https://github.com/sciknoworg/OntoAligner/blob/main/examples/icv_rag_matching.py)
50+
| eCommerce | [📚 Product Alignment in eCommerce](https://ontoaligner.readthedocs.io/usecases/ecommerce.html) | [📝 Code](https://github.com/sciknoworg/OntoAligner/blob/dev/examples/ecommerce_product_alignment.py)
5051

5152
## 🚀 Quick Tour
5253

@@ -129,24 +130,22 @@ print("Matching Evaluation Report:", evaluation)
129130
```
130131
## ⭐ Contribution
131132

132-
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.
133+
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.
133134

134135

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

137138

138139
## 💡 Acknowledgements
139140

140-
If you use OntoAligner in your work or research, please cite the following:
141+
If you use OntoAligner in your work or research, please cite the following preprint:
141142

142143
```bibtex
143-
@software{babaei_giglou_ontoaligner_2025,
144-
author = {Hamed Babaei Giglou and Jennifer D'Souza and Oliver Karras and S{"o}ren Auer},
145-
title = {OntoAligner: A Comprehensive Modular and Robust Python Toolkit for Ontology Alignment},
146-
version = {1.3.0},
147-
year = {2025},
148-
url = {https://github.com/sciknoworg/OntoAligner},
149-
doi = https://doi.org/10.5281/zenodo.14533133
144+
@article{giglou2025ontoaligner,
145+
title={Ontoaligner: A comprehensive modular and robust python toolkit for ontology alignment},
146+
author={Giglou, Hamed Babaei and D'Souza, Jennifer and Karras, Oliver and Auer, S{\"o}ren},
147+
journal={arXiv preprint arXiv:2503.21902},
148+
year={2025}
150149
}
151150
```
152151

‎ontoaligner/__init__.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
__version__ = "1.3.0"
33

44
from .pipeline import OntoAlignerPipeline
5-
from ontoaligner import ontology, base, encoder, ontology_matchers, utils, postprocess
5+
from ontoaligner import ontology, base, encoder, aligner, utils, postprocess
66

77
__all__ = [
88
"ontology",
99
"base",
1010
"encoder",
11-
"ontology_matchers",
11+
"aligner",
1212
"utils",
1313
"postprocess",
1414
"OntoAlignerPipeline"

‎pyproject.toml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ tqdm = "4.66.3"
2121
owlready2 = "0.44"
2222
rdflib = "7.1.1"
2323
ontospy = "2.1.1"
24-
torch = "2.5.0"
25-
transformers = "4.48.2"
24+
torch = "2.7.0"
25+
transformers = "4.50.0"
2626
rapidfuzz = "3.5.2"
2727
openai = "1.56.0"
2828
rank_bm25 = "0.2.2"
@@ -37,6 +37,7 @@ pre-commit = "*"
3737
setuptools = "*"
3838
wheel = "*"
3939
twine = "*"
40+
pytest = "*"
4041

4142
[build-system]
4243
requires = ["poetry-core>=1.0.0"]

‎requirements.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ rank_bm25==0.2.2
1111
rapidfuzz==3.5.2
1212
rdflib==7.1.1
1313
sentence_transformers==3.4.1
14-
torch==2.5.0
14+
torch==2.7.0
1515
tqdm==4.66.3
16-
transformers==4.48.2
16+
transformers==4.50.0
1717
huggingface_hub==0.28.1
1818
setfit==1.1.1
1919
bitsandbytes==0.45.1

‎setup.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@
2727
"rapidfuzz==3.5.2",
2828
"rdflib==7.1.1",
2929
"sentence-transformers==3.4.1",
30-
"torch==2.5.0",
30+
"torch==2.7.0",
3131
"tqdm==4.66.3",
32-
"transformers==4.48.2",
32+
"transformers==4.50.0",
3333
"huggingface_hub==0.28.1",
3434
"setfit==1.1.1",
3535
"bitsandbytes==0.45.1",

0 commit comments

Comments
 (0)