fuzzy-dl-owl2 1.0.6__tar.gz → 1.0.7__tar.gz

{fuzzy_dl_owl2-1.0.6 → fuzzy_dl_owl2-1.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fuzzy-dl-owl2
-Version: 1.0.6
+Version: 1.0.7
 Summary: A python porting of the Fuzzy Description Language (see https://www.umbertostraccia.it/cs/software/fuzzyDL/fuzzyDL.html) and the Fuzzy OWL 2 framework (see https://www.umbertostraccia.it/cs/software/FuzzyOWL/index.html).
 License: CC-BY-SA-4.0
 Author: Giuseppe Filippone
@@ -11,12 +11,12 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: gurobipy (>=12.0.0,<13.0.0)
 Requires-Dist: networkx (>=3.3,<4.0)
 Requires-Dist: owlready2 (>=0.47,<0.48)
 Requires-Dist: pyowl2 (>=1.0.2,<2.0.0)
 Requires-Dist: pyparsing (>=3.2.3,<4.0.0)
 Requires-Dist: rdflib (>=7.1.4,<8.0.0)
+Requires-Dist: setuptools (>=80.8.0,<81.0.0)
 Requires-Dist: sortedcontainers (>=2.4.0,<3.0.0)
 Requires-Dist: trycast (>=1.2.0,<2.0.0)
 Project-URL: Repository, https://github.com/giuseppefilippone/fuzzy_dl_owl2
@@ -78,17 +78,85 @@ The file `CONFIG.ini` is structured as follows:
 ```text
 [DEFAULT]
 debugPrint = False
-relaxMilp = False
 epsilon = 0.001
 maxIndividuals = -1
+owlAnnotationLabel = fuzzyLabel
+milpProvider = mip
 ```
 
 | Configuration Variable | Description                       |
 |----------------------|-----------------------------------|
 | debugPrint        | Enable/disable debugging          |
-| relaxMilp      | Enable/disable MILP constraint relaxation. Important: The solution may be wrong by enabling this flag |
 | epsilon | Define the precision of the solution. For instance, epsilon = 0.001 means that the solution will be calculated with an accuracy to the third decimal place |
 | maxIndividuals | Define the maximal number of individuals to handle. The value -1 indicate that there is no maximum |
+| owlAnnotationLabel | Define the Annotation label used to build the Fuzzy OWL 2 RDF/XML ontology |
+| milpProvider | Define the MILP provider used by the reasoner. The supported providers are listed below. |
+
+Supported MILP Providers:
+| Provider | milpProvider |
+|--------------|----------------------|
+| Gurobi | gurobi |
+| CPLEX | pulp_cplex |
+| CBC | pulp |
+| GLPK | pulp_glpk |
+| HiGHS | pulp_highs |
+| MIP | mip |
+
+⸻
+
+# MILP Provider Usage and Configuration
+
+## GUROBI
+
+- Install [gurobipy](https://pypi.org/project/gurobipy/):
+```python
+pip install gurobipy==12.0.0
+```
+- Download the GUROBI license from their [website](https://www.gurobi.com/solutions/licensing/).
+- Add Gurobi to the PATH
+
+## MIP
+
+- Install python [MIP](https://www.python-mip.com/):
+```python
+pip install mip==1.16rc0
+```
+
+## GLPK
+
+- Install [GLPK](https://www.gnu.org/software/glpk/) v5.0 and [GMP](https://gmplib.org/) v6.3.0
+- Install python [pulp](https://github.com/coin-or/PuLP?tab=readme-ov-file):
+```python
+pip install pulp==3.2.1
+```
+- Add GLPK to the PATH
+
+## CBC
+
+- Install [CBC](https://github.com/coin-or/Cbc)
+- Install python [pulp](https://github.com/coin-or/PuLP?tab=readme-ov-file):
+```python
+pip install pulp==3.2.1
+```
+- Add CBC to the PATH
+
+## CPLEX
+
+- Install [CPLEX](https://www.ibm.com/it-it/products/ilog-cplex-optimization-studio) v22.11
+- Install python [pulp](https://github.com/coin-or/PuLP?tab=readme-ov-file):
+```python
+pip install pulp==3.2.1
+```
+- Add CPLEX to the PATH
+
+## HiGHS
+
+- Install [HiGHS](https://ergo-code.github.io/HiGHS/dev/interfaces/cpp/) v1.10.0
+- Install python [pulp](https://github.com/coin-or/PuLP?tab=readme-ov-file):
+```python
+pip install pulp==3.2.1
+```
+- Add HiGHS to the PATH
 
 ⸻
 

{fuzzy_dl_owl2-1.0.6 → fuzzy_dl_owl2-1.0.7}/README.md

@@ -54,17 +54,85 @@ The file `CONFIG.ini` is structured as follows:
 ```text
 [DEFAULT]
 debugPrint = False
-relaxMilp = False
 epsilon = 0.001
 maxIndividuals = -1
+owlAnnotationLabel = fuzzyLabel
+milpProvider = mip
 ```
 
 | Configuration Variable | Description                       |
 |----------------------|-----------------------------------|
 | debugPrint        | Enable/disable debugging          |
-| relaxMilp      | Enable/disable MILP constraint relaxation. Important: The solution may be wrong by enabling this flag |
 | epsilon | Define the precision of the solution. For instance, epsilon = 0.001 means that the solution will be calculated with an accuracy to the third decimal place |
 | maxIndividuals | Define the maximal number of individuals to handle. The value -1 indicate that there is no maximum |
+| owlAnnotationLabel | Define the Annotation label used to build the Fuzzy OWL 2 RDF/XML ontology |
+| milpProvider | Define the MILP provider used by the reasoner. The supported providers are listed below. |
+
+Supported MILP Providers:
+| Provider | milpProvider |
+|--------------|----------------------|
+| Gurobi | gurobi |
+| CPLEX | pulp_cplex |
+| CBC | pulp |
+| GLPK | pulp_glpk |
+| HiGHS | pulp_highs |
+| MIP | mip |
+
+⸻
+
+# MILP Provider Usage and Configuration
+
+## GUROBI
+
+- Install [gurobipy](https://pypi.org/project/gurobipy/):
+```python
+pip install gurobipy==12.0.0
+```
+- Download the GUROBI license from their [website](https://www.gurobi.com/solutions/licensing/).
+- Add Gurobi to the PATH
+
+## MIP
+
+- Install python [MIP](https://www.python-mip.com/):
+```python
+pip install mip==1.16rc0
+```
+
+## GLPK
+
+- Install [GLPK](https://www.gnu.org/software/glpk/) v5.0 and [GMP](https://gmplib.org/) v6.3.0
+- Install python [pulp](https://github.com/coin-or/PuLP?tab=readme-ov-file):
+```python
+pip install pulp==3.2.1
+```
+- Add GLPK to the PATH
+
+## CBC
+
+- Install [CBC](https://github.com/coin-or/Cbc)
+- Install python [pulp](https://github.com/coin-or/PuLP?tab=readme-ov-file):
+```python
+pip install pulp==3.2.1
+```
+- Add CBC to the PATH
+
+## CPLEX
+
+- Install [CPLEX](https://www.ibm.com/it-it/products/ilog-cplex-optimization-studio) v22.11
+- Install python [pulp](https://github.com/coin-or/PuLP?tab=readme-ov-file):
+```python
+pip install pulp==3.2.1
+```
+- Add CPLEX to the PATH
+
+## HiGHS
+
+- Install [HiGHS](https://ergo-code.github.io/HiGHS/dev/interfaces/cpp/) v1.10.0
+- Install python [pulp](https://github.com/coin-or/PuLP?tab=readme-ov-file):
+```python
+pip install pulp==3.2.1
+```
+- Add HiGHS to the PATH
 
 ⸻
 

{fuzzy_dl_owl2-1.0.6 → fuzzy_dl_owl2-1.0.7}/fuzzy_dl_owl2/fuzzydl/feature_function.py

@@ -122,26 +122,32 @@ class FeatureFunction:
         self, a: Individual, milp: MILPHelper
     ) -> typing.Optional[Expression]:
         if self.type == FeatureFunctionType.ATOMIC:
+            # Get the filler "b" for feature(a)
             rel_set: list[Relation] = a.role_relations.get(self.feature)
+            assert len(rel_set) > 0
             b: CreatedIndividual = typing.cast(
                 CreatedIndividual, rel_set[0].get_object_individual()
             )
+            # Get the variable xB
             x_b: Variable = milp.get_variable(b)
             return Expression(Term(1.0, x_b))
         elif self.type == FeatureFunctionType.NUMBER:
             return Expression(self.n)
         elif self.type == FeatureFunctionType.PRODUCT:
+            assert len(self.f) == 1
             ex: Expression = self.f[0].to_expression(a, milp)
-            return Expression.multiply_constant(ex, self.n)
+            return ex * self.n
         elif self.type == FeatureFunctionType.SUBTRACTION:
+            assert len(self.f) == 2
             ex1: Expression = self.f[0].to_expression(a, milp)
             ex2: Expression = self.f[1].to_expression(a, milp)
-            return Expression.subtract_expressions(ex1, ex2)
+            return ex1 - ex2
         elif self.type == FeatureFunctionType.SUM:
+            assert len(self.f) >= 1
             ex1: Expression = self.f[0].to_expression(a, milp)
             for i in range(1, len(self.f)):
                 ex2: Expression = self.f[i].to_expression(a, milp)
-                ex1: Expression = Expression.add_expressions(ex1, ex2)
+                ex1 = ex1 + ex2
             return ex1
         return None
 

{fuzzy_dl_owl2-1.0.6 → fuzzy_dl_owl2-1.0.7}/fuzzy_dl_owl2/fuzzydl/fuzzydl_to_owl2.py

@@ -129,6 +129,8 @@ from pyowl2.individual.named_individual import OWLNamedIndividual
 from pyowl2.literal.literal import OWLLiteral
 from pyowl2.ontology import OWLOntology
 
+from fuzzy_dl_owl2.fuzzydl.util.config_reader import ConfigReader
+
 
 # @utils.timer_decorator
 class FuzzydlToOwl2:
@@ -149,7 +151,7 @@ class FuzzydlToOwl2:
             self.ontology_iri, OWL1_annotations=True
         )
         self.fuzzyLabel: OWLAnnotationProperty = OWLAnnotationProperty(
-            IRI(self.ontology_iri.namespace, "fuzzyLabel")
+            IRI(self.ontology_iri.namespace, ConfigReader.OWL_ANNOTATION_LABEL)
         )
 
         self.ontology.add_axiom(OWLDeclaration(self.fuzzyLabel))

{fuzzy_dl_owl2-1.0.6 → fuzzy_dl_owl2-1.0.7}/fuzzy_dl_owl2/fuzzydl/knowledge_base.py

@@ -6435,6 +6435,7 @@ class DatatypeReasoner:
         k: list[float],
         type: InequalityType,
     ) -> None:
+        # Gets fillers bi from every feature fi
         array: set[str] = fun.get_features()
         new_variable: bool = False
         for feature in array:
@@ -6454,21 +6455,28 @@ class DatatypeReasoner:
                 x_fi: Variable = kb.milp.get_variable(
                     ind, bi, feature, VariableType.BINARY
                 )
+                # (a,bi):Fi >= x_{(a,bi):Fi}
                 IndividualHandler.add_relation(
                     ind, feature, bi, DegreeVariable.get_degree(x_fi), kb
                 )
-            x_bi: Variable = (
-                kb.milp.get_variable(bi, VariableType.INTEGER)
-                if t.get_type() == ConcreteFeatureType.INTEGER
-                else kb.milp.get_variable(bi, VariableType.CONTINUOUS)
+            x_bi: Variable = kb.milp.get_variable(
+                bi,
+                (
+                    VariableType.INTEGER
+                    if t.get_type() == ConcreteFeatureType.INTEGER
+                    else VariableType.CONTINUOUS
+                ),
             )
-            if new_variable is not None and ki is not None:
+            if new_variable and ki is not None:
                 kb.restrict_range(x_bi, x_fi, ki[0], ki[1])
+            # xIsC <= xFi
             kb.milp.add_new_constraint(
                 Expression(Term(1.0, x_is_c), Term(-1.0, x_fi)),
                 InequalityType.LESS_THAN,
             )
+            # xF \in {0,1}
             x_fi.set_binary_variable()
+            # xB is a datatype filler
             x_bi.set_datatype_filler_variable()
         DatatypeReasoner.write_feature_equation(ind, fun, x_b, x_is_c, x_f, k, type, kb)
 

{fuzzy_dl_owl2-1.0.6 → fuzzy_dl_owl2-1.0.7}/fuzzy_dl_owl2/fuzzydl/milp/expression.py

@@ -98,7 +98,7 @@ class Expression:
 
     def add_term(self, term: Term) -> None:
         for idx, t in enumerate(self.terms):
-            if t == term:
+            if t.get_var() == term.get_var():
                 self.terms[idx] = t + term
                 return
         self.terms.append(term)
@@ -169,6 +169,17 @@ class Expression:
     def __truediv__(self, scalar: typing.Union[int, float]) -> typing.Self:
         return self * (1 / scalar)
 
+    def __hash__(self) -> int:
+        return hash(str(self))
+
+    def __eq__(self, value: typing.Self) -> bool:
+        if not isinstance(value, Expression):
+            return False
+        return len(self.terms) == len(value.terms) and all(term in value.terms for term in self.terms)
+
+    def __ne__(self, value: typing.Self) -> bool:
+        return not (self == value)
+
     def __repr__(self) -> str:
         return str(self)
 
@@ -184,5 +195,5 @@ class Expression:
             elif n == -1.0:
                 parts.append(f"- {term.get_var()}")
             else:
-                parts.append(f"{'+ ' if n >= 0 else '- '}{n} {term.get_var()}")
+                parts.append(f"{'+ ' if n >= 0 else '- '}{abs(n)} {term.get_var()}")
         return " ".join(parts)

{fuzzy_dl_owl2-1.0.6 → fuzzy_dl_owl2-1.0.7}/fuzzy_dl_owl2/fuzzydl/milp/inequation.py

@@ -43,6 +43,18 @@ class Inequation:
         assert self.type == InequalityType.GREATER_THAN
         return ">="
 
+    def is_zero(self) -> bool:
+        return all(term.get_coeff() == 0 for term in self.expr.get_terms()) and self.expr.get_constant() == 0
+
+    def __hash__(self) -> int:
+        return hash(str(self))
+
+    def __eq__(self, value: typing.Self) -> bool:
+        return self.expr == value.expr and self.type == value.type
+
+    def __ne__(self, value: typing.Self) -> bool:
+        return not (self == value)
+
     def __repr__(self) -> str:
         return str(self)