Updated API for v1.0.0

.github/workflows/build.yml

@@ -13,7 +13,7 @@ jobs:
         strategy:
             matrix:
                 platform: [ubuntu-latest, macos-latest, windows-latest]
-                python-version: ["3.7", "3.8", "3.9"]
+                python-version: ["3.9", "3.10", "3.11"]
                 # No gpu workflow yet!: https://github.com/apache/singa/issues/802
 
         steps:
@@ -31,3 +31,5 @@ jobs:
               run: tox
               env:
                   PLATFORM: ${{ matrix.platform }}
+            - name: Check code formatting
+              run: tox -e lint

.github/workflows/coverage.yml

@@ -1,4 +1,4 @@
-name: Coverage
+name: coverage
 
 on:
     push:
@@ -13,10 +13,10 @@ jobs:
         # Setup lastest python version
         steps:
             - uses: actions/checkout@v2
-            - name: Set up Python 3.8
+            - name: Set up Python 3.10
               uses: actions/setup-python@v2
               with:
-                  python-version: "3.8"
+                  python-version: "3.10"
 
             - name: Install dependencies
               run: |
@@ -26,8 +26,7 @@ jobs:
             - name: Coverage tests
               run: pytest --cov=cooper . --cov-report term-missing
 
-            - name: Codecov
-              if: success()
+            - name: Upload coverage reports to Codecov
+              uses: codecov/codecov-action@v3
               env:
-                  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-              run: codecov
+                CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.pre-commit-config.yaml

@@ -10,6 +10,11 @@ repos:
     -   id: black
     -   id: black-jupyter
 -   repo: https://github.com/pycqa/isort
-    rev: 5.10.1
+    rev: 5.12.0
     hooks:
     - id: isort
+-   repo: https://github.com/pycqa/flake8
+    rev: 6.1.0
+    hooks:
+    -   id: flake8
+        exclude: ^docs/

.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-20.04
   tools:
-    python: "3.8"
+    python: "3.9"
     # You can also specify other tool versions:
     # nodejs: "16"
     # rust: "1.55"

README.md

@@ -3,7 +3,9 @@
 [![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cooper-org/cooper/tree/master/LICENSE)
 [![DOCS](https://readthedocs.org/projects/cooper/badge/?version=latest)](https://cooper.readthedocs.io/en/latest/?version=latest)
 [![Build and Test](https://github.com/cooper-org/cooper/actions/workflows/build.yml/badge.svg)](https://github.com/cooper-org/cooper/actions/workflows/build.yml)
-[![Codecov](https://codecov.io/gh/cooper-org/cooper/branch/dev/graph/badge.svg?token=1AKM2EQ7RT)](https://codecov.io/gh/cooper-org/cooper/branch/dev/graph/badge.svg?token=1AKM2EQ7RT)
+[![Coverage](https://codecov.io/gh/cooper-org/cooper/graph/badge.svg?token=4U41P8JCE1)](https://codecov.io/gh/cooper-org/cooper)
+[![HitCount](https://hits.dwyl.com/cooper-org/cooper.svg?style=flat-square)](https://cooper.readthedocs.io/en/latest/?version=latest)
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/cooper-org/cooper/issues)
 
 ## About
 
@@ -38,7 +40,7 @@ training a Logistic Regression clasifier on the MNIST dataset. The model is
 constrained so that the squared L2 norm of its parameters is less than 1.
 
 This example illustrates how **Cooper** integrates with:
-- constructing a ``cooper.LagrangianFormulation`` and a ``cooper.SimultaneousConstrainedOptimizer``
+- constructing a ``cooper.LagrangianFormulation`` and a ``cooper.SimultaneousOptimizer``
 - models defined using a ``torch.nn.Module``,
 - CUDA acceleration,
 - typical machine learning training loops,
@@ -65,7 +67,7 @@ dual_optimizer = cooper.optim.partial_optimizer(torch.optim.SGD, lr=1e-3)
 
 # Create a ConstrainedOptimizer for performing simultaneous updates based on the
 # formulation, and the selected primal and dual optimizers.
-cooper_optimizer = cooper.SimultaneousConstrainedOptimizer(
+cooper_optimizer = cooper.SimultaneousOptimizer(
     formulation, primal_optimizer, dual_optimizer
 )
 

cooper/__init__.py

@@ -1,4 +1,4 @@
-"""Top-level package for Constrained Optimization in Pytorch."""
+"""Top-level package for Cooper."""
 
 import sys
 
@@ -13,23 +13,10 @@
     # package is not installed
     import warnings
 
-    warnings.warn("Could not retrieve cooper version!")
+    warnings.warn("Could not retrieve Cooper version!")
 
-from cooper.formulation import (
-    AugmentedLagrangianFormulation,
-    Formulation,
-    LagrangianFormulation,
-    UnconstrainedFormulation,
-)
-from cooper.optim import (
-    AlternatingConstrainedOptimizer,
-    ConstrainedOptimizer,
-    CooperOptimizer,
-    ExtrapolationConstrainedOptimizer,
-    SimultaneousConstrainedOptimizer,
-    UnconstrainedOptimizer,
-)
-from cooper.problem import CMPState, ConstrainedMinimizationProblem
-from cooper.utils import StateLogger
+from cooper.cmp import CMPState, ConstrainedMinimizationProblem, LagrangianStore
+from cooper.constraints import ConstraintGroup, ConstraintState, ConstraintType
+from cooper.formulations import FormulationType
 
-from . import formulation, multipliers, optim, utils
+from . import formulations, multipliers, optim, utils