Features dev

docs/requirements.txt

@@ -4,5 +4,9 @@ sphinx_autodoc_typehints
 myst-parser
 sphinx_markdown_tables
 sphinx-copybutton
-sphinx_inline_tabs
 sphinxcontrib-mermaid
+sphinx-panels
+sphinx-design
+sphinx-tabs
+sphinx-inline-tabs
+snowballstemmer

docs/source/_templates/ontology.rst

@@ -0,0 +1,68 @@
+{{ ontology_name }}
+========================================================================================================================
+
+Overview
+--------
+{{ description }}
+
+:Domain: {{ domain }}
+:Category: {{ category }}
+:Current Version: {{ version }}
+:Last Updated: {{ last_updated }}
+:Creator: {{ creator }}
+:License: {{ license }}
+:Format: {{ format }}
+:Download: `{{ ontology_name }} Homepage <{{ download_url }}>`_
+
+Graph Metrics
+-------------
+    - **Total Nodes**: {{ total_nodes }}
+    - **Total Edges**: {{ total_edges }}
+    - **Root Nodes**: {{ root_nodes }}
+    - **Leaf Nodes**: {{ leaf_nodes }}
+
+Knowledge coverage
+------------------
+    - Classes: {{ num_classes }}
+    - Individuals: {{ num_individuals }}
+    - Properties: {{ num_properties }}
+
+Hierarchical metrics
+--------------------
+    - **Maximum Depth**: {{ max_depth }}
+    - **Minimum Depth**: {{ min_depth }}
+    - **Average Depth**: {{ avg_depth }}
+    - **Depth Variance**: {{ depth_variance }}
+
+Breadth metrics
+------------------
+    - **Maximum Breadth**: {{ max_breadth }}
+    - **Minimum Breadth**: {{ min_breadth }}
+    - **Average Breadth**: {{ avg_breadth }}
+    - **Breadth Variance**: {{ breadth_variance }}
+
+Dataset Statistics
+------------------
+Generated Benchmarks:
+    - **Term Types**: {{ num_term_types }}
+    - **Taxonomic Relations**: {{ num_taxonomic_relations }}
+    - **Non-taxonomic Relations**: {{ num_non_taxonomic_relations }}
+    - **Average Terms per Type**: {{ avg_terms_per_type }}
+
+Usage Example
+-------------
+.. code-block:: python
+
+    from ontolearner.ontology import {{ class_name }}
+
+    # Initialize and load ontology
+    ontology = {{ class_name }}()
+    ontology.load("path/to/ontology.{{ format }}")
+
+    # Extract datasets
+    data = ontology.extract()
+
+    # Access specific relations
+    term_types = data.term_typings
+    taxonomic_relations = data.type_taxonomies
+    non_taxonomic_relations = data.type_non_taxonomic_relations

docs/source/_templates/ontology2.rst

@@ -0,0 +1,122 @@
+{{ ontology_name }}
+==============================================================================
+
+Overview
+--------
+{{ description }}
+
+.. container:: metadata-columns
+
+   .. container:: left-column
+
+      :Domain: {{ domain }}
+      :Category: {{ category }}
+      :Current Version: {{ version }}
+      :Last Updated: {{ last_updated }}
+      :Creator: {{ creator }}
+      :License: {{ license }}
+      :Format: {{ format }}
+
+   .. container:: right-column
+
+      .. container:: download-button
+
+         `Download {{ ontology_name }} <{{ download_url }}>`_
+
+Metrics & Statistics
+-------------------
+
+.. tabs::
+
+   .. tab:: Graph Metrics
+
+      .. list-table::
+         :widths: 50 50
+         :header-rows: 0
+
+         * - **Total Nodes**
+           - {{ total_nodes }}
+         * - **Total Edges**
+           - {{ total_edges }}
+         * - **Root Nodes**
+           - {{ root_nodes }}
+         * - **Leaf Nodes**
+           - {{ leaf_nodes }}
+
+   .. tab:: Knowledge Coverage
+
+      .. list-table::
+         :widths: 50 50
+         :header-rows: 0
+
+         * - **Classes**
+           - {{ num_classes }}
+         * - **Individuals**
+           - {{ num_individuals }}
+         * - **Properties**
+           - {{ num_properties }}
+
+   .. tab:: Hierarchical Metrics
+
+      .. list-table::
+         :widths: 50 50
+         :header-rows: 0
+
+         * - **Maximum Depth**
+           - {{ max_depth }}
+         * - **Minimum Depth**
+           - {{ min_depth }}
+         * - **Average Depth**
+           - {{ avg_depth }}
+         * - **Depth Variance**
+           - {{ depth_variance }}
+
+   .. tab:: Breadth Metrics
+
+      .. list-table::
+         :widths: 50 50
+         :header-rows: 0
+
+         * - **Maximum Breadth**
+           - {{ max_breadth }}
+         * - **Minimum Breadth**
+           - {{ min_breadth }}
+         * - **Average Breadth**
+           - {{ avg_breadth }}
+         * - **Breadth Variance**
+           - {{ breadth_variance }}
+
+   .. tab:: Dataset Statistics
+
+      **Generated Benchmarks**:
+
+      .. list-table::
+         :widths: 50 50
+         :header-rows: 0
+
+         * - **Term Types**
+           - {{ num_term_types }}
+         * - **Taxonomic Relations**
+           - {{ num_taxonomic_relations }}
+         * - **Non-taxonomic Relations**
+           - {{ num_non_taxonomic_relations }}
+         * - **Average Terms per Type**
+           - {{ avg_terms_per_type }}
+
+Usage Example
+-------------
+.. code-block:: python
+
+    from ontolearner.ontology import {{ class_name }}
+
+    # Initialize and load ontology
+    ontology = {{ class_name }}()
+    ontology.load("path/to/ontology.owl")
+
+    # Extract datasets
+    data = ontology.extract()
+
+    # Access specific relations
+    term_types = data.term_typings
+    taxonomic_relations = data.type_taxonomies
+    non_taxonomic_relations = data.type_non_taxonomic_relations

docs/source/benchmarking/agricultural/agrovoc.rst

@@ -1,5 +1,5 @@
-AGROVOC Multilingual Thesaurus
-===================================
+AGROVOC Multilingual Thesaurus (AGROVOC)
+========================================================================================================================
 
 Overview
 --------
@@ -14,8 +14,8 @@ indexing processes and making searches more efficient.
 :Last Updated: August 12, 2024
 :Creator: Food and Agriculture Organization of the United Nations
 :License: Creative Commons 4.0
-:Format: RDF, SKOS
-:Download: `AGROVOC Multilingual Thesaurus Homepage <https://agroportal.lirmm.fr/ontologies/AGROVOC>`_
+:Format: RDF
+:Download: `AGROVOC Multilingual Thesaurus (AGROVOC) Homepage <https://agroportal.lirmm.fr/ontologies/AGROVOC>`_
 
 Graph Metrics
 -------------
@@ -47,10 +47,10 @@ Breadth metrics
 Dataset Statistics
 ------------------
 Generated Benchmarks:
-    - **Term Types**: 1234769
-    - **Taxonomic Relations**: 13
+    - **Term Types**: 12
+    - **Taxonomic Relations**: 11
     - **Non-taxonomic Relations**: 7
-    - **Average Terms per Type**: 47491.12
+    - **Average Terms per Type**: 3.00
 
 Usage Example
 -------------
@@ -60,7 +60,7 @@ Usage Example
 
     # Initialize and load ontology
     ontology = AGROVOC()
-    ontology.load("path/to/ontology.owl")
+    ontology.load("path/to/ontology.RDF")
 
     # Extract datasets
     data = ontology.extract()

docs/source/benchmarking/agricultural/foodon.rst

@@ -1,5 +1,5 @@
 Food Ontology (FoodON)
-==========================
+========================================================================================================================
 
 Overview
 --------
@@ -49,9 +49,9 @@ Dataset Statistics
 ------------------
 Generated Benchmarks:
     - **Term Types**: 16
-    - **Taxonomic Relations**: 98513
-    - **Non-taxonomic Relations**: 7924
-    - **Average Terms per Type**: 0.94
+    - **Taxonomic Relations**: 76235
+    - **Non-taxonomic Relations**: 2072
+    - **Average Terms per Type**: 8.00
 
 Usage Example
 -------------
@@ -61,7 +61,7 @@ Usage Example
 
     # Initialize and load ontology
     ontology = FoodOn()
-    ontology.load("path/to/ontology.owl")
+    ontology.load("path/to/ontology.OWL")
 
     # Extract datasets
     data = ontology.extract()

docs/source/benchmarking/agricultural/po.rst

@@ -1,5 +1,5 @@
 Plant Ontology (PO)
-==========================
+========================================================================================================================
 
 Overview
 --------
@@ -12,7 +12,7 @@ morphology and growth and development to plant genomics data.
 :Last Updated: None
 :Creator: None
 :License: Creative Commons 4.0
-:Format: OWL, TTL, CSV, NT
+:Format: OWL
 :Download: `Plant Ontology (PO) Homepage <https://github.com/Planteome/plant-ontology>`_
 
 Graph Metrics
@@ -46,8 +46,8 @@ Dataset Statistics
 ------------------
 Generated Benchmarks:
     - **Term Types**: 0
-    - **Taxonomic Relations**: 5288
-    - **Non-taxonomic Relations**: 117
+    - **Taxonomic Relations**: 2866
+    - **Non-taxonomic Relations**: 36
     - **Average Terms per Type**: 0.00
 
 Usage Example
@@ -58,7 +58,7 @@ Usage Example
 
     # Initialize and load ontology
     ontology = PO()
-    ontology.load("path/to/ontology.owl")
+    ontology.load("path/to/ontology.OWL")
 
     # Extract datasets
     data = ontology.extract()

docs/source/benchmarking/arts_&_humanities/chordontology.rst → docs/source/benchmarking/arts_and_humanities/chordontology.rst

@@ -1,18 +1,18 @@
-Chord Ontology
-==========================
+Chord Ontology (ChordOntology)
+========================================================================================================================
 
 Overview
 --------
 The Chord Ontology is an ontology for describing chords in musical pieces.
 
-:Domain: Arts & Humanities
+:Domain: Arts and Humanities
 :Category: Musical Works
 :Current Version: 1.0
 :Last Updated: 2007-10-25
 :Creator: Yves Raimond, Samer Abdallah, Centre for Digital Music, Queen Mary, University of London
 :License: Creative Commons 3.0
-:Format: RDF/XML
-:Download: `Chord Ontology Homepage <https://github.com/motools/chordontology>`_
+:Format: RDF
+:Download: `Chord Ontology (ChordOntology) Homepage <https://github.com/motools/chordontology>`_
 
 Graph Metrics
 -------------
@@ -44,10 +44,10 @@ Breadth metrics
 Dataset Statistics
 ------------------
 Generated Benchmarks:
-    - **Term Types**: 108
+    - **Term Types**: 42
     - **Taxonomic Relations**: 4
     - **Non-taxonomic Relations**: 0
-    - **Average Terms per Type**: 5.68
+    - **Average Terms per Type**: 10.50
 
 Usage Example
 -------------
@@ -57,7 +57,7 @@ Usage Example
 
     # Initialize and load ontology
     ontology = ChordOntology()
-    ontology.load("path/to/ontology.owl")
+    ontology.load("path/to/ontology.RDF")
 
     # Extract datasets
     data = ontology.extract()

docs/source/benchmarking/arts_&_humanities/icon.rst → docs/source/benchmarking/arts_and_humanities/icon.rst

@@ -1,13 +1,13 @@
 Icon Ontology (ICON)
-==========================
+========================================================================================================================
 
 Overview
 --------
 The ICON ontology deals with high granularity art interpretation. It was developed by conceptualizing
 Panofsky's theory of levels of interpretation, therefore artworks can be described according
 to Pre-iconographical, Iconographical and Iconological information.
 
-:Domain: Arts & Humanities
+:Domain: Arts and Humanities
 :Category: Art History, Cultural Heritage
 :Current Version: 2.1.0
 :Last Updated: April 26th, 2024
@@ -47,7 +47,7 @@ Dataset Statistics
 ------------------
 Generated Benchmarks:
     - **Term Types**: 0
-    - **Taxonomic Relations**: 126
+    - **Taxonomic Relations**: 65
     - **Non-taxonomic Relations**: 4
     - **Average Terms per Type**: 0.00
 
@@ -59,7 +59,7 @@ Usage Example
 
     # Initialize and load ontology
     ontology = ICON()
-    ontology.load("path/to/ontology.owl")
+    ontology.load("path/to/ontology.OWL")
 
     # Extract datasets
     data = ontology.extract()