Final release edits (changelog, deprecations, version numbers)

Author: jsiirola

.coin-or/projDesc.xml

@@ -227,8 +227,8 @@ Carl D. Laird, Chair, Pyomo Management Committee, claird at andrew dot cmu dot e
 			     Use explicit overrides to disable use of automated
 			     version reporting.
 			-->
-			<stableVersionNumber>6.4.2</stableVersionNumber>
-			<releaseNumber>6.4.2</releaseNumber>
+			<stableVersionNumber>6.4.3</stableVersionNumber>
+			<releaseNumber>6.4.3</releaseNumber>
 
 		</developmentStatus>
 

CHANGELOG.txt

@@ -7,19 +7,16 @@ Pyomo 6.4.3    28 Nov 2022
 -------------------------------------------------------------------------------
 
 - General
-  - Update performance driver to be usable outside of Pyomo (#2505)
   - Update PauseGC to work in nested contexts (#2507)
   - Simplify deepcopy/pickle logic to speed up model clone (#2510)
-  - Fix generate_standard_repo to handle unexpected NPV expressions (#2511)
-  - Add thread safe proxies for singleton instances (PauseGC, TempFileManager) (#2514)
-  - Fix bug in ConstructionTimer for components indexed by nonfinite sets (#2518)
-  - Add differentiation mode option to calculate_variable_from_constraint (#2549)
+  - Fix generate_standard_repn to handle unexpected NPV expressions (#2511)
+  - Add thread safe proxies for PauseGC, TempFileManager singletons (#2514)
+  - Fix ConstructionTimer bug for components indexed by nonfinite sets (#2518)
+  - Add calculate_variable_from_constraint differentiation mode option (#2549)
   - Update URL for downloading GSL and GJH (#2556, #2588)
   - Update logic for retrying failed downloads (#2569)
-  - Allow nan to compare equal in assertStructuredAlmostEqual() (#2582)
-  - Add support and testing for Python 3.11 (#2596)
+  - Add support and testing for Python 3.11 (#2596, #2618)
   - Update deprecation utilities to improve user messages (#2606)
-  - Add Python 3.11 to wheel creation workflow (#2618)
 - Core
   - Refactor expression hierarchy, add RelationalExpression base class (#2499)
   - Support cloning individual blocks (#2504)
@@ -29,33 +26,32 @@ Pyomo 6.4.3    28 Nov 2022
   - Improve handling of restricted words on Blocks (#2535)
   - Improve Reference() performance (#2537)
   - Fix mapping gradient/hessian for external functions with string args (#2539)
-  - Updates and fixes for the NLv2 writer (#2540, #2622)
   - Fix bug for sum_product(Var, Param, Param) (#2551)
   - Add deprecation path for expression objects moved to relational_expr (#2554)
-  - Raise exception when setting value of Expression to non-numeric expression (#2567)
-  - Update tracking of used named subexpressions in NLv2 writer (#2568)
-  - Add test utilities for comparing expressions (#2590)
-  - Fix some performance degradations from pyomo.contrib.cp (#2612)
+  - Exception when setting value of Expression to non-numeric expression (#2567)
   - Improve deepcopy performance (#2628)
 - Documentation
   - Fix examples in working_models.rst (#2502)
 - Solver Interfaces
   - Improve SCIP results object (#2462)
   - Improve warning message when LP writer raises KeyError (#2497)
   - Fix Gurobi work limit bug (#2530)
+  - Updates and fixes for the NLv2 writer (#2540, #2622, #2568)
   - Fix Xpress when stopped due to MAXTIME or MAXNODES (#2553)
   - Add support for MOSEK 10 affine conic constraints (#2557)
   - Fix missing explicit space in GAMS put command (#2578)
   - Fix GAMS logfile storage location (#2580)
-  - Update LP writer to not sort terms when file_determinism=0 (#2583)
-  - Update LP writer to not parse quadratic terms when not supported by solver (#2585)
+  - LP writer performance improvements (#2583, #2585)
   - Update handling of MOSEK Env and Python module (#2591)
   - Release MOSEK license when optimize raises a mosek.Error (#2593)
   - Update list of allowable characters in CPLEX filenames (#2597)
 - Testing
+  - Update performance driver to be usable outside of Pyomo (#2505)
   - Update the performance test driver (#2538)
   - Reduce amount of environment code cached in GitHub actions (#2565)
   - Update GitHub actions versions from v2 to v3 (#2566)
+  - Allow nan to compare equal in assertStructuredAlmostEqual() (#2582)
+  - Add test utilities for comparing expressions (#2590)
   - Skip a test in MOSEK 10 due to a bug in warm starting MIQPs (#2614)
   - Update skipped CBC test that works with CBC 2.10.6 (#2615)
   - Add SCIP to GitHub actions environment (#2602)
@@ -72,24 +68,24 @@ Pyomo 6.4.3    28 Nov 2022
   - APPSI: Fix exception raised by appsi_gurobi during Python shutdown (#2498)
   - APPSI: Improve handling of Gurobi results (#2517)
   - APPSI: Add interface to HiGHS solver (#2561)
-  - APPSI: Only release Gurobi license if all instances have been deleted (#2599)
+  - APPSI: Only release Gurobi license after deleting all instances (#2599)
   - APPSI: Patch IntEnum to preserve pre-3.11 formatting (#2607)
-  - cp: New package for constraint programming (#2570)
+  - CP: New package for constraint programming (#2570, #2612)
   - GDPopt: Add warning when reporting results from LBB (#2534)
   - GDPopt: Delete dummy objective when we're done using it (#2552)
   - GDPopt: Add enumerate solution approach (#2559, #2575)
-  - iis: Add package for computing the IIS of an infeasible Pyomo model (#2512)
+  - IIS: Add package for computing the IIS of an infeasible Pyomo model (#2512)
   - MindtPy: Fix bug in termination condition (#2587)
   - MindtPy: Fix bug in checking absolute and relative gap (#2608)
-  - mpc: Data structures and utils for rolling horizon dynamic optimization (#2477)
+  - MPC: Data structures/utils for rolling horizon dynamic optimization (#2477)
   - Parmest: Solve square problem to initialize regression problem (#2438)
   - Parmest: Return ContinuousSet values from theta_est() (#2464)
-  - PyNumero: Fix numpy deprecation warnings (#2521)
+  - PyNumero: Fix NumPy deprecation warnings (#2521)
   - PyNumero: Add interfaces to SciPy square solvers (#2523)
-  - PyNumero: Check that AmplInterface is available in SciPy solver tests (#2594)
+  - PyNumero: Check AmplInterface availability in SciPy solver tests (#2594)
   - PyNumero: Add ProjectedExtendedNLP class (#2601)
   - PyNumero: Add interface to SciPy scalar Newton solver (#2603)
-  - PyROS: Rewrite UncertaintySet docstrings and improve validation robustness (#2488)
+  - PyROS: Rewrite UncertaintySet docstrings/improve validation (#2488)
   - PyROS: Updates to subproblem initialization and solver call routines (#2515)
   - PyROS: Fix collection of sub-solver solve times (#2543)
 

README.md

@@ -26,6 +26,7 @@ including:
  -  Generalized disjunctive programming
  -  Differential algebraic equations
  -  Mathematical programming with equilibrium constraints
+ -  Constraint programming
 
 Pyomo supports analysis and scripting within a full-featured programming
 language. Further, Pyomo has also proven an effective framework for

RELEASE.txt

@@ -1,4 +1,4 @@
-We are pleased to announce the release of Pyomo 6.4.2.
+We are pleased to announce the release of Pyomo 6.4.3.
 
 Pyomo is a collection of Python software packages that supports a
 diverse set of optimization capabilities for formulating and analyzing
@@ -9,11 +9,14 @@ The following are highlights of the 6.0 release series:
  - Improved stability and robustness of core Pyomo code and solver interfaces
  - Integration of Boolean variables into GDP
  - Integration of NumPy support into the Pyomo expression system
- - Added support for Python 3.10
+ - Added support for Python 3.10, 3.11
  - Removed support for Python 3.6
  - New packages:
     - APPSI (Auto-Persistent Pyomo Solver Interfaces)
+    - CP (Constraint programming models and solver interfaces)
     - External grey box models
+    - IIS (Standard interface to solver IIS capabilities)
+    - MPC (Data structures/utils for rolling horizon dynamic optimization)
     - PyROS (Pyomo Robust Optimization Solver)
     - Structural model analysis
     - Rewrite of the TrustRegion Solver

pyomo/core/expr/boolean_value.py

@@ -94,7 +94,8 @@ def is_fixed(self):
         return False
 
     @deprecated("is_relational() is deprecated in favor of "
-                "is_expression_type(ExpressionType.RELATIONAL)", version='TBD')
+                "is_expression_type(ExpressionType.RELATIONAL)",
+                version='6.4.3')
     def is_relational(self):
         """
         Return True if this Logical value represents a relational expression.

pyomo/core/expr/expr_common.py

@@ -76,7 +76,7 @@ class ExpressionType(enum.Enum):
 Beginning with Pyomo5 expressions, expression cloning (detangling) no
 longer occurs automatically within expression generation.  As a result,
 the 'clone counter' has lost its utility and is no longer supported.
-This context manager will always report 0.""", version='TBD')
+This context manager will always report 0.""", version='6.4.3')
 class clone_counter(nullcontext):
     """ Context manager for counting cloning events.
 

pyomo/core/expr/logical_expr.py

@@ -46,19 +46,19 @@
 relocated_module_attribute(
     'EqualityExpression',
     'pyomo.core.expr.relational_expr.EqualityExpression',
-    version='TBD')
+    version='6.4.3')
 relocated_module_attribute(
     'InequalityExpression',
     'pyomo.core.expr.relational_expr.InequalityExpression',
-    version='TBD')
+    version='6.4.3')
 relocated_module_attribute(
     'RangedExpression',
     'pyomo.core.expr.relational_expr.RangedExpression',
-    version='TBD')
+    version='6.4.3')
 relocated_module_attribute(
     'inequality',
     'pyomo.core.expr.relational_expr.inequality',
-    version='TBD')
+    version='6.4.3')
 
 
 def _generate_logical_proposition(etype, lhs, rhs):
@@ -117,7 +117,7 @@ def args(self):
 
 class BooleanExpressionBase(metaclass=RenamedClass):
     __renamed__new_class__ = BooleanExpression
-    __renamed__version__ = 'TBD'
+    __renamed__version__ = '6.4.3'
 
 
 """

pyomo/core/expr/numeric_expr.py

@@ -142,7 +142,7 @@ def args(self):
     @deprecated('The implicit recasting of a "not potentially variable" '
                 'expression node to a potentially variable one is no '
                 'longer supported (this violates that immutability '
-                'promise for Pyomo5 expression trees).', version='TBD')
+                'promise for Pyomo5 expression trees).', version='6.4.3')
     def create_potentially_variable_object(self):
         """
         Create a potentially variable version of this object.

pyomo/core/expr/numvalue.py

@@ -367,7 +367,7 @@ def as_numeric(obj):
             deprecation_warning(
                 "returning a relational expression from as_numeric().  "
                 "Relational expressions are no longer numeric types.  "
-                "In the future this will raise a TypeError.", version='TBD')
+                "In the future this will raise a TypeError.", version='6.4.3')
             return obj
         else:
             try:
@@ -436,7 +436,7 @@ def check_if_numeric_type(obj):
 
 
 @deprecated("check_if_numeric_type_and_cache() has been deprecated in "
-            "favor of just calling as_numeric()", version='TBD')
+            "favor of just calling as_numeric()", version='6.4.3')
 def check_if_numeric_type_and_cache(obj):
     """Test if the argument is a numeric type by checking if we can add
     zero to it.  If that works, then we cache the value and return a
@@ -495,7 +495,8 @@ def is_potentially_variable(self):
         return False
 
     @deprecated("is_relational() is deprecated in favor of "
-                "is_expression_type(ExpressionType.RELATIONAL)", version='TBD')
+                "is_expression_type(ExpressionType.RELATIONAL)",
+                version='6.4.3')
     def is_relational(self):
         """
         Return True if this numeric value represents a relational expression.

pyomo/core/expr/relational_expr.py

@@ -67,7 +67,8 @@ def args(self):
         return self._args_[:self.nargs()]
 
     @deprecated("is_relational() is deprecated in favor of "
-                "is_expression_type(ExpressionType.RELATIONAL)", version='TBD')
+                "is_expression_type(ExpressionType.RELATIONAL)",
+                version='6.4.3')
     def is_relational(self):
         return self.is_expression_type(ExpressionType.RELATIONAL)