cognite-neat 0.78.1__py3-none-any.whl → 0.78.2__py3-none-any.whl

cognite/neat/_version.py

@@ -1 +1 @@
-__version__ = "0.78.1"
+__version__ = "0.78.2"

cognite/neat/rules/importers/_owl2rules/_owl2classes.py

@@ -8,19 +8,17 @@ from cognite.neat.rules.models._base import MatchType
 from cognite.neat.utils.utils import remove_namespace
 
 
-def parse_owl_classes(graph: Graph, make_compliant: bool = False, language: str = "en") -> list[dict]:
+def parse_owl_classes(graph: Graph, language: str = "en") -> list[dict]:
     """Parse owl classes from graph to pandas dataframe.
 
     Args:
         graph: Graph containing owl classes
-        make_compliant: Flag for generating compliant classes, by default False
         language: Language to use for parsing, by default "en"
 
     Returns:
         Dataframe containing owl classes
 
-    !!! note "make_compliant"
-        If `make_compliant` is set to True, in presence of errors, default values will be used instead.
+    !!! note "Compliant OWL classes"
         This makes the method very opinionated, but results in a compliant classes.
     """
 
@@ -48,8 +46,7 @@ def parse_owl_classes(graph: Graph, make_compliant: bool = False, language: str
     processed_df = _clean_up_classes(raw_df)
 
     # make compliant
-    if make_compliant:
-        processed_df = make_classes_compliant(processed_df)
+    processed_df = make_classes_compliant(processed_df)
 
     # Make Parent Class list elements into string joined with comma
     processed_df["Parent Class"] = processed_df["Parent Class"].apply(

cognite/neat/rules/importers/_owl2rules/_owl2metadata.py

@@ -12,18 +12,16 @@ from cognite.neat.rules.models._types._base import (
 from cognite.neat.utils.utils import convert_rdflib_content, remove_none_elements_from_set
 
 
-def parse_owl_metadata(graph: Graph, make_compliant: bool = False) -> dict:
+def parse_owl_metadata(graph: Graph) -> dict:
     """Parse owl metadata from graph to dict.
 
     Args:
         graph: Graph containing owl metadata
-        make_compliant: Flag for generating compliant metadata, by default False
 
     Returns:
         Dictionary containing owl metadata
 
-    !!! note "make_compliant"
-        If `make_compliant` is set to True, in presence of errors, default values will be used instead.
+    !!! note "Compliant OWL metadata"
         This makes the method very opinionated, but results in a compliant metadata.
 
 
@@ -72,10 +70,7 @@ def parse_owl_metadata(graph: Graph, make_compliant: bool = False) -> dict:
         }
     )
 
-    if make_compliant:
-        return make_metadata_compliant(raw_metadata)
-
-    return raw_metadata
+    return make_metadata_compliant(raw_metadata)
 
 
 def make_metadata_compliant(metadata: dict) -> dict:

cognite/neat/rules/importers/_owl2rules/_owl2properties.py

@@ -10,12 +10,11 @@ from cognite.neat.utils.utils import remove_namespace
 from ._owl2classes import _data_type_property_class, _object_property_class, _thing_class
 
 
-def parse_owl_properties(graph: Graph, make_compliant: bool = False, language: str = "en") -> list[dict]:
+def parse_owl_properties(graph: Graph, language: str = "en") -> list[dict]:
     """Parse owl properties from graph to pandas dataframe.
 
     Args:
         graph: Graph containing owl properties
-        make_compliant: Flag for generating compliant properties, by default False
         language: Language to use for parsing, by default "en"
 
     Returns:
@@ -53,8 +52,7 @@ def parse_owl_properties(graph: Graph, make_compliant: bool = False, language: s
     processed_df = _clean_up_properties(raw_df)
 
     # make compliant
-    if make_compliant:
-        processed_df = make_properties_compliant(processed_df)
+    processed_df = make_properties_compliant(processed_df)
 
     # drop column _property_type, which was a helper column:
     processed_df.drop(columns=["_property_type"], inplace=True)

cognite/neat/rules/importers/_owl2rules/_owl2rules.py

@@ -21,25 +21,21 @@ class OWLImporter(BaseImporter):
 
         Args:
             filepath: Path to OWL ontology
-            make_compliant: If True, NEAT will attempt to make the imported rules compliant with CDF
 
     !!! Note
-        OWL Ontologies typically lacks some information that is required for making a complete
-        data model. This means that the methods .to_rules() will typically fail. Instead, it is recommended
-        that you use the .to_spreadsheet() method to generate an Excel file, and then manually add the missing
-        information to the Excel file. The Excel file can then be converted to a `Rules` object.
+        OWL Ontologies are information models which completeness varies. As such, constructing functional
+        data model directly will often be impossible, therefore the produced Rules object will be ill formed.
+        To avoid this, neat will automatically attempt to make the imported rules compliant by adding default
+        values for missing information, attaching dangling properties to default containers based on the
+        property type, etc.
 
-        Alternatively, one can set the `make_compliant` parameter to True to allow neat to attempt to make
-        the imported rules compliant by adding default values for missing information, attaching dangling
-        properties to default containers based on the property type, etc. One has to be aware
-        that NEAT will be opinionated about how to make the ontology compliant, and that the resulting
-        rules may not be what you expect.
+        One has to be aware that NEAT will be opinionated about how to make the ontology
+        compliant, and that the resulting rules may not be what you expect.
 
     """
 
-    def __init__(self, filepath: Path, make_compliant: bool = False):
+    def __init__(self, filepath: Path):
         self.owl_filepath = filepath
-        self.make_compliant = make_compliant
 
     @overload
     def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules: ...
@@ -67,13 +63,12 @@ class OWLImporter(BaseImporter):
         graph.bind("skos", SKOS)
 
         components = {
-            "Metadata": parse_owl_metadata(graph, make_compliant=self.make_compliant),
-            "Classes": parse_owl_classes(graph, make_compliant=self.make_compliant),
-            "Properties": parse_owl_properties(graph, make_compliant=self.make_compliant),
+            "Metadata": parse_owl_metadata(graph),
+            "Classes": parse_owl_classes(graph),
+            "Properties": parse_owl_properties(graph),
         }
 
-        if self.make_compliant:
-            components = make_components_compliant(components)
+        components = make_components_compliant(components)
 
         rules = InformationRules.model_validate(components)
         return self._to_output(rules, IssueList(), errors, role)

cognite/neat/workflows/steps/lib/current/rules_importer.py

@@ -119,15 +119,6 @@ class OntologyToRules(Step):
             label="For what role Rules are intended?",
             options=["infer", *RoleTypes.__members__.keys()],
         ),
-        Configurable(
-            name="Make compliant",
-            value="True",
-            label=(
-                "Attempt to make the imported Rules compliant, by converting "
-                "the information model provided in the ontology to data model."
-            ),
-            options=["True", "False"],
-        ),
     ]
 
     def run(self, flow_message: FlowMessage) -> (FlowMessage, MultiRuleData):  # type: ignore[syntax, override]
@@ -136,7 +127,6 @@ class OntologyToRules(Step):
 
         file_name = self.configs.get("File name", None)
         full_path = flow_message.payload.get("full_path", None) if flow_message.payload else None
-        make_compliant = self.configs.get("Make compliant", "True") == "True"
 
         if file_name:
             rules_file_path = self.config.rules_store_path / file_name
@@ -152,7 +142,7 @@ class OntologyToRules(Step):
         if role != "infer" and role is not None:
             role_enum = RoleTypes[role]
 
-        ontology_importer = importers.OWLImporter(filepath=rules_file_path, make_compliant=make_compliant)
+        ontology_importer = importers.OWLImporter(filepath=rules_file_path)
         rules, issues = ontology_importer.to_rules(errors="continue", role=role_enum)
 
         if rules is None:

{cognite_neat-0.78.1.dist-info → cognite_neat-0.78.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cognite-neat
-Version: 0.78.1
+Version: 0.78.2
 Summary: Knowledge graph transformation
 Home-page: https://cognite-neat.readthedocs-hosted.com/
 License: Apache-2.0

{cognite_neat-0.78.1.dist-info → cognite_neat-0.78.2.dist-info}/RECORD

@@ -1,5 +1,5 @@
 cognite/neat/__init__.py,sha256=v-rRiDOgZ3sQSMQKq0vgUQZvpeOkoHFXissAx6Ktg84,61
-cognite/neat/_version.py,sha256=HinYe1V3FgUaLri1gy6R6_VuKh3sB-UYTNM51cV6k4I,23
+cognite/neat/_version.py,sha256=kWBpkJnZGsOhuJ5bhE96-VWCpvSaENAUiBvGF98dgWI,23
 cognite/neat/app/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/app/api/asgi/metrics.py,sha256=nxFy7L5cChTI0a-zkCiJ59Aq8yLuIJp5c9Dg0wRXtV0,152
 cognite/neat/app/api/configuration.py,sha256=2U5M6M252swvQPQyooA1EBzFUZNtcTmuSaywfJDgckM,4232
@@ -180,10 +180,10 @@ cognite/neat/rules/importers/_dtdl2rules/dtdl_importer.py,sha256=QDyGt5YBaxzF4v_
 cognite/neat/rules/importers/_dtdl2rules/spec.py,sha256=tim_MfN1J0F3Oeqk3BMgIA82d_MZvhRuRMsLK3B4PYc,11897
 cognite/neat/rules/importers/_inference2rules.py,sha256=CFSwf8ZTg_luMooBaP3_0762fjDlJxCoxjLRm4J2_m4,11187
 cognite/neat/rules/importers/_owl2rules/__init__.py,sha256=tdGcrgtozdQyST-pTlxIa4cLBNTLvtk1nNYR4vOdFSw,63
-cognite/neat/rules/importers/_owl2rules/_owl2classes.py,sha256=LInFeBq-NbBIuMEAwgWch2a4DbBUt4_OMqPkwehW-sw,7591
-cognite/neat/rules/importers/_owl2rules/_owl2metadata.py,sha256=NdPN0dBB0NYkAcfC0yrYdIrGfdPbl5gfeGnSV3EtUPM,7786
-cognite/neat/rules/importers/_owl2rules/_owl2properties.py,sha256=BLptGmH-Aa5gZu0hDIxSZTrn9GmB2FicWgRYoETLSnQ,7437
-cognite/neat/rules/importers/_owl2rules/_owl2rules.py,sha256=vyXtAhHCg-zCv_sfq28bx5BK96GXoCB4KA5LeO_ZuvU,6917
+cognite/neat/rules/importers/_owl2rules/_owl2classes.py,sha256=QpTxvrTGczIa48X8lgXGnMN1AWPhHK0DR6uNq175xak,7357
+cognite/neat/rules/importers/_owl2rules/_owl2metadata.py,sha256=nwnUaBNAAYMoBre2UmsnkJXUuaqGEpR3U3txDrH2w6g,7527
+cognite/neat/rules/importers/_owl2rules/_owl2properties.py,sha256=eKr-e-ZTTV54PJ9UXNVPTT_c9XxszNPraS4Y43AF7qQ,7297
+cognite/neat/rules/importers/_owl2rules/_owl2rules.py,sha256=41_wZFvt0A6TI55zlT04oQkvU7V73li4aGLgc4T4Lxo,6358
 cognite/neat/rules/importers/_spreadsheet2rules.py,sha256=nKSJyZGoTho0bqQ_5_1XB9Z1C-MwovRgkVrC-AhOuzs,12438
 cognite/neat/rules/importers/_yaml2rules.py,sha256=F0uksSz1A3po5OlRM2152_w5j8D9oYTLB9NFTkSMlWI,4275
 cognite/neat/rules/issues/__init__.py,sha256=Ms6jgCxCezc5IgTOwCFtXQPtoVFfOvdcXj84_rs917I,563
@@ -259,7 +259,7 @@ cognite/neat/workflows/steps/lib/current/graph_extractor.py,sha256=vW9UpJScx5dFV
 cognite/neat/workflows/steps/lib/current/graph_loader.py,sha256=HfGg1HRZhbV58TFu89FTjKeUxGsbCYLeFJIQFDN_pQM,2341
 cognite/neat/workflows/steps/lib/current/graph_store.py,sha256=r7VTxdaz8jJQU7FJbnRDMxvEYbSAZFNMABhPyfNwiFk,6295
 cognite/neat/workflows/steps/lib/current/rules_exporter.py,sha256=iFwzDWgUDBSPajaNAcXvu9pVw-jX66upvwyMXyTq7SE,23822
-cognite/neat/workflows/steps/lib/current/rules_importer.py,sha256=u79hnIulQ14TsScfwvcXp2UcvNhBX0E4ESxIJloerRY,15626
+cognite/neat/workflows/steps/lib/current/rules_importer.py,sha256=sZJv367gxLrF_ZrQrE8nibIEYh3N6JYiOjZ2MeBO1Cs,15190
 cognite/neat/workflows/steps/lib/current/rules_validator.py,sha256=LwF9lXlnuPOxDSsOMMTHBi2BHc5rk08IF5zahS9yQuw,4844
 cognite/neat/workflows/steps/lib/io/__init__.py,sha256=k7IPbIq3ey19oRc5sA_15F99-O6dxzqbm1LihGRRo5A,32
 cognite/neat/workflows/steps/lib/io/io_steps.py,sha256=QAGypoi1vP32BRiIgBZ0B4qsbFMcwhzpRiVUUnWysLA,16874
@@ -276,8 +276,8 @@ cognite/neat/workflows/steps_registry.py,sha256=fkTX14ZA7_gkUYfWIlx7A1XbCidvqR23
 cognite/neat/workflows/tasks.py,sha256=dqlJwKAb0jlkl7abbY8RRz3m7MT4SK8-7cntMWkOYjw,788
 cognite/neat/workflows/triggers.py,sha256=_BLNplzoz0iic367u1mhHMHiUrCwP-SLK6_CZzfODX0,7071
 cognite/neat/workflows/utils.py,sha256=gKdy3RLG7ctRhbCRwaDIWpL9Mi98zm56-d4jfHDqP1E,453
-cognite_neat-0.78.1.dist-info/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.78.1.dist-info/METADATA,sha256=yDfESAmMuhuO2LxGTEozKPAOKN9z7RM1NmxeXRJCkEU,9306
-cognite_neat-0.78.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-cognite_neat-0.78.1.dist-info/entry_points.txt,sha256=61FPqiWb25vbqB0KI7znG8nsg_ibLHBvTjYnkPvNFso,50
-cognite_neat-0.78.1.dist-info/RECORD,,
+cognite_neat-0.78.2.dist-info/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.78.2.dist-info/METADATA,sha256=iUWwZcRnmk4ccIsio_g3ktMvOuv2Bi6vdvoke6ERqys,9306
+cognite_neat-0.78.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+cognite_neat-0.78.2.dist-info/entry_points.txt,sha256=61FPqiWb25vbqB0KI7znG8nsg_ibLHBvTjYnkPvNFso,50
+cognite_neat-0.78.2.dist-info/RECORD,,