Skip to main content

Build Status codecov License DOI

Devos

Depicting Vocabulary Summaries(Devos) is a tool that generates a visual summary from a given ontology. Devos is built on top of Mermaid syntax which is a Markdown-inspired tool that renders text in diagrams and it uses SPARQL Query Language over the ontology generating a visual summary. It's based on three approaches.

  1. OntMet. Uses Ontology Meta Data to find matching classes.
  2. ClaFreq. Relies on Class Frequency in the ontology as the importance signal.
  3. LabLen. Utilizes Label Length of the classes as the importance signal. The intuition is that importance classes have richer metadata than less important classes.

Main Features

  • Generate summary diagrams.
    • Allows the user to use the summarisation technique (e.g., using meta data, class frequency, or label length)
  • Enrich ontologies with labels for the classes that are missing them.

Dependencies

Install

pip install devos-py

Usage

There are three main ways to use Devos. Web application, Python Library, and as a standalone application (CLI).

Web Application

The web application is built using Flask. To run it, you can use the following command: python -m web.app. This will start the server on 127.0.0.1:5000. You can also pass the port as a parameter.

As a library

You have three main functions: meta_workflow, freq_workflow, and leng_workflow. The all expects the path to the ontology, the output path to the summary diagram, and the maximum number of classes topn (referred to it in paper as k).

CLI Tutorial

  1. Use meta data as the signal for importance
python -m devos.gister -i data/ieswc/cocoon.ttl --freq
python -m devos.gister -i data/ieswc_enriched/ck.ttl -t -d -a  


python -m devos.gister -i data/ieswc_enriched/explanation-ontology.owl  -t -d -a --topn 7


python -m devos.gister -i data/ieswc_enriched/devops/core.ttl   --freq --topn 7

python -m devos.gister -i data/ieswc_enriched/devops/core.ttl   --freq --topn 7

Example:

	classDiagram

Agent  --> Document   :interest  

Person  --> Document   :publications  

Thing  --> Document   :page  


Agent  --> Thing   :topic_interest  

Thing  --> Agent   :maker  

Group  --> Agent   :member  

Experimentation

Experiments

Tests

To run unit tests

python -m unittest discover tests 

Authors

  • Ahmad Alobaid - (Ontology Engineering Group - UPM)
  • Jhon Toledo - (Ontology Engineering Group - UPM)
  • [María Poveda Villalón] - (Ontology Engineering Group - UPM)
  • [Oscar Corcho] - (Ontology Engineering Group - UPM)

Ontology Engineering Group, Universidad Politécnica de Madrid.

License

DeVoS is available under the permissive Apache License 2.0.

PyPi

python -m build
twine check dist/*
twine upload dist/*

Metadata

Release files for devos-py 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for devos-py 1.0.1
File Size Uploaded
devos-py-1.0.1.tar.gz 24.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for devos-py 1.0.1
File Interpreter ABI Platform
devos_py-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 47.3 kB

Release files / devos-py-1.0.1.tar.gz

Download URL devos-py-1.0.1.tar.gz
Size 24.5 kB
Tags Source
SHA-256 checksum
How to use checksums
36d57f6a1dcfbdb26705cb16060619f026fad4fb7d0957b20bf9bab0649ca268
BLAKE2b-256 checksum
How to use checksums
c879671cacbdc5702d8023c1520749e9a5cf17ddf73009b8c5af348dde6f94ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.9

Release files / devos_py-1.0.1-py3-none-any.whl

Download URL devos_py-1.0.1-py3-none-any.whl
Size 22.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
39bf2f3e1aca84e80cdd6b60ef9256ea0a952ae73b5ab5f5364df117f2b66aae
BLAKE2b-256 checksum
How to use checksums
30c52b7865f2a6131e44ab548d446986c085f6aaa661acc34780e65269601598
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.9

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page