pykp 3.1.2__tar.gz → 3.2.0__tar.gz

{pykp-3.1.2 → pykp-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pykp
-Version: 3.1.2
+Version: 3.2.0
 Summary: Tooling for sampling and solving instances of the 0-1 Knapsack Problem.
 Author-email: Hassan Andrabi <hrs.andrabi@gmail.com>
 License: MIT

{pykp-3.1.2 → pykp-3.2.0}/pykp/metrics.py

@@ -41,19 +41,19 @@ def _initialise_grid(
         The first array corresponds to normalised capacities, and the second
         to normalised profits.
     """
-    norm_c_step_size = 1 / resolution[0]
-    norm_p_step_size = 1 / resolution[1]
+    norm_c_step_size = 1 / resolution[1]
+    norm_p_step_size = 1 / resolution[0]
 
     grid = np.meshgrid(
-        np.linspace(0, 1 - norm_c_step_size, resolution[0]),
-        np.linspace(1 - norm_p_step_size, 0, resolution[1]),
+        np.linspace(0, 1 - norm_c_step_size, resolution[1]),
+        np.linspace(1 - norm_p_step_size, 0, resolution[0]),
     )
 
     return grid
 
 
 def _sample_instance(
-    num_items: int, norm_c: float, norm_p: float
+    num_items: int, norm_c: float, norm_p: float, rng: np.random.Generator
 ) -> tuple[list[Item], float, float]:
     """
     Sample a knapsack instance based on normalised capacity and profit targets.
@@ -71,6 +71,8 @@ def _sample_instance(
         Normalised capacity factor to scale the total weight.
     norm_p : float
         Normalised profit factor to scale the total value.
+    rng : np.random.Generator
+        Random number generator for sampling.
 
     Returns
     -------
@@ -81,8 +83,8 @@ def _sample_instance(
     target_profit : float
         The scaled target profit.
     """
-    weights = np.random.uniform(0, 1, num_items)
-    profits = np.random.uniform(0, 1, num_items)
+    weights = rng.uniform(0.001, 1, num_items)
+    profits = rng.uniform(0.001, 1, num_items)
 
     capacity = sum(weights) * norm_c
     target_profit = sum(profits) * norm_p
@@ -99,6 +101,7 @@ def _simulate_cell_solvability(
     num_items: int,
     samples: int,
     solver: Callable,
+    rng: np.random.Generator,
     progress: tqdm,
 ) -> float:
     """Estimate the solvability of a grid cell.
@@ -121,6 +124,8 @@ def _simulate_cell_solvability(
     solver : Callable
         A solver function that takes items and capacity as arguments and
         returns an optimal node or array of optimal nodes.
+    rng : np.random.Generator
+        Random number generator for sampling.
     progress : tqdm
         Progress bar for tracking iterations.
 
@@ -133,11 +138,14 @@ def _simulate_cell_solvability(
     """
     score = 0
     for _ in range(samples):
-        norm_c_draw = np.random.uniform(norm_c_range[0], norm_c_range[1])
-        norm_p_draw = np.random.uniform(norm_p_range[0], norm_p_range[1])
+        norm_c_draw = rng.uniform(norm_c_range[0], norm_c_range[1])
+        norm_p_draw = rng.uniform(norm_p_range[0], norm_p_range[1])
 
         items, capacity, target_profit = _sample_instance(
-            num_items=num_items, norm_c=norm_c_draw, norm_p=norm_p_draw
+            num_items=num_items,
+            norm_c=norm_c_draw,
+            norm_p=norm_p_draw,
+            rng=rng,
         )
         result = solver(items=items, capacity=capacity)
         if isinstance(result, list):
@@ -187,6 +195,7 @@ def phase_transition(
     samples: int = 100,
     solver: str = "branch_and_bound",
     resolution: tuple[int, int] = (41, 41),
+    seed: int | None = None,
     path: str = None,
 ) -> tuple[np.ndarray, np.ndarray]:
     """Compute the phase transition matrix for knapsack instances.
@@ -218,9 +227,10 @@ def phase_transition(
 
     Returns
     -------
-        grid : tuple of np.ndarray
-            The mesh grid for normalszed capacities (x-axis) and profits
-            (y-axis).
+        coordinate_matrices : tuple of np.ndarray
+            The coordinate matrices for normalised capacities and normalised
+            profits. The first matrix corresponds to normalised capacities,
+            and the second to normalised profits.
         phase_transition : np.ndarray
             A 2D matrix of solvability (ranging from 0.0 to 1.0) corresponding
             to each cell in `grid`.
@@ -233,9 +243,12 @@ def phase_transition(
     resolution: tuple[int, int], optional
         Resolution of the normalised capacity-normalised profit grid.
         The first element corresponds to the resolution of normalised
-        capacity, and the second to the resolution of normalised profit.
+        profit, and the second to the resolution of normalised capacity.
         Defaults to (41, 41).
-    path (str, optional): Path to save the phase transition to. Defaults
+    seed : int | None, optional
+        Seed for sampling. Defaults to None.
+    path str, optional:
+        Path to save the phase transition to. Defaults
         to None.
 
     Examples
@@ -309,6 +322,7 @@ def phase_transition(
             [(p, p + 1 / resolution[1]) for p in grid[1].flatten()],
         )
     )
+    rng = np.random.default_rng(seed)
 
     phase_transition = []
     with tqdm(total=samples * len(points)) as progress:
@@ -320,12 +334,11 @@ def phase_transition(
                 samples=samples,
                 solver=solver,
                 progress=progress,
+                rng=rng,
             )
             phase_transition.append(solvability)
 
-    phase_transition = np.array(phase_transition).reshape(
-        (resolution[0], resolution[1])
-    )
+    phase_transition = np.array(phase_transition).reshape(resolution)
 
     if path:
         _save_phase_transition(phase_transition, grid, path)

{pykp-3.1.2 → pykp-3.2.0}/pykp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pykp
-Version: 3.1.2
+Version: 3.2.0
 Summary: Tooling for sampling and solving instances of the 0-1 Knapsack Problem.
 Author-email: Hassan Andrabi <hrs.andrabi@gmail.com>
 License: MIT

{pykp-3.1.2 → pykp-3.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pykp"
-version = "3.1.2"
+version = "3.2.0"
 description = "Tooling for sampling and solving instances of the 0-1 Knapsack Problem."
 authors = [
     { name = "Hassan Andrabi", email = "hrs.andrabi@gmail.com" }

{pykp-3.1.2 → pykp-3.2.0}/tests/test_metrics.py

@@ -22,8 +22,8 @@ def test_phase_transition_returns_correct_shape(resolution):
         resolution=resolution,
         path=None,
     )
-    assert grid[0].shape == (resolution[1], resolution[0])
-    assert grid[1].shape == (resolution[1], resolution[0])
+    assert grid[0].shape == resolution
+    assert grid[1].shape == resolution
 
     assert solvability_matrix.shape == resolution
 
@@ -97,3 +97,34 @@ def test_phase_transition_values_in_range():
     assert np.all(solvability_matrix >= 0.0) and np.all(
         solvability_matrix <= 1.0
     ), "Solvability values are not all within [0, 1]."
+
+
+@pytest.mark.parametrize("seed", [1, 2, 3])
+def test_phase_transition_reproducibility(seed):
+    """Test that the phase transition is reproducible."""
+    resolution = (2, 2)
+    num_items = 5
+    samples = 5
+    grid, solvability_matrix = metrics.phase_transition(
+        num_items=num_items,
+        samples=samples,
+        solver="branch_and_bound",
+        resolution=resolution,
+        path=None,
+        seed=seed,
+    )
+
+    grid2, solvability_matrix2 = metrics.phase_transition(
+        num_items=num_items,
+        samples=samples,
+        solver="branch_and_bound",
+        resolution=resolution,
+        path=None,
+        seed=seed,
+    )
+
+    assert np.all(grid[0] == grid2[0]), "Inconsistent grid."
+    assert np.all(grid[0] == grid2[0]), "Inconsistent grid."
+    assert np.all(solvability_matrix == solvability_matrix2), (
+        "Inconsistent solvability matrix."
+    )