@File : init.py @Time : 2024/09/18 11:03:14 @Author : Alejandro Marrero @Version : 1.0 @Contact : amarrerd@ull.edu.es @License : (C)Copyright 2024, Alejandro Marrero @Desc : None

ArchivePlotter

Maintains a live matplotlib figure showing the GridArchive as a heatmap.

The colour of each cell encodes a chosen scalar attribute of its elite (default: p, the performance bias). Empty cells are shown in a distinct neutral colour so it is easy to see how the archive fills up.

Parameters:
  • archive (GridArchive) –

    The 2-D archive to visualise.

  • attr (str, default: 'p' ) –

    Instance attribute to use as colour value. Default "p".

  • feat_names (Sequence[str], default: None ) –

    Labels for the two feature axes.

  • cmap (str, default: 'viridis' ) –

    Matplotlib colormap name. Default "viridis".

  • vmin / vmax (float | None) –

    Fixed colour scale limits. If None (default), the scale is recomputed each frame from the data.

  • figsize (tuple[float, float], default: (7, 6) ) –

    Figure size in inches.

  • title (str, default: 'MAP-Elites Archive' ) –

    Figure window / suptitle text.

Source code in digneapy/visualize/_archive_plotter.py
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
class ArchivePlotter:
    """Maintains a live matplotlib figure showing the GridArchive as a heatmap.

    The colour of each cell encodes a chosen scalar attribute of its elite
    (default: ``p``, the performance bias).  Empty cells are shown in a
    distinct neutral colour so it is easy to see how the archive fills up.

    Args:
        archive (GridArchive): The 2-D archive to visualise.
        attr (str): Instance attribute to use as colour value. Default ``"p"``.
        feat_names (Sequence[str]): Labels for the two feature axes.
        cmap (str): Matplotlib colormap name. Default ``"viridis"``.
        vmin / vmax (float | None): Fixed colour scale limits.  If ``None``
            (default), the scale is recomputed each frame from the data.
        figsize (tuple[float, float]): Figure size in inches.
        title (str): Figure window / suptitle text.
    """

    def __init__(
        self,
        archive: GridArchive,
        attr: str = "p",
        feat_names: Optional[Sequence[str]] = None,
        cmap: str = "viridis",
        vmin: Optional[float] = None,
        vmax: Optional[float] = None,
        figsize: tuple[float, float] = (7, 6),
        title: str = "MAP-Elites Archive",
    ):
        if len(archive.dimensions) != 2:
            raise ValueError(
                "ArchivePlotter only supports 2d GridArchives. "
                f"Got dimensions={archive.dimensions}"
            )

        self._archive = archive
        self._attr = attr
        self._feat_names = feat_names or ["Feature 0", "Feature 1"]
        self._cmap = cmap
        self._vmin = vmin
        self._vmax = vmax

        self._fig, self._ax = plt.subplots(figsize=figsize)
        self._fig.suptitle(title, fontsize=13, fontweight="bold")
        plt.ion()  # non-blocking interactive mode

        rows, cols = int(archive.dimensions[0]), int(archive.dimensions[1])
        empty = np.full((rows, cols), np.nan)

        # Empty-cell background (neutral grey)
        bg_cmap = mcolors.ListedColormap(["#d0d0d0"])
        self._ax.imshow(
            np.zeros_like(empty),
            cmap=bg_cmap,
            aspect="auto",
            origin="lower",
            extent=[-0.5, cols - 0.5, -0.5, rows - 0.5],
        )

        # Elite heatmap layer (NaN = transparent → shows grey background)
        cm = plt.get_cmap(self._cmap).copy()
        cm.set_bad(color="none")  # NaN → transparent
        self._im = self._ax.imshow(
            empty,
            cmap=cm,
            aspect="auto",
            origin="lower",
            extent=[-0.5, cols - 0.5, -0.5, rows - 0.5],
            interpolation="nearest",
        )

        # Colour bar
        self._cbar = self._fig.colorbar(self._im, ax=self._ax, pad=0.02)
        self._cbar.set_label(f"Elite  '{attr}'  value", fontsize=10)

        # Axis labels & ticks
        self._ax.set_xlabel(self._feat_names[0], fontsize=11)
        self._ax.set_ylabel(self._feat_names[1], fontsize=11)

        x_pos, x_lbl = _axis_tick_labels(archive, dim=0)
        y_pos, y_lbl = _axis_tick_labels(archive, dim=1)
        self._ax.set_xticks(x_pos)
        self._ax.set_xticklabels(x_lbl, fontsize=8)
        self._ax.set_yticks(y_pos)
        self._ax.set_yticklabels(y_lbl, fontsize=8)

        # Stats text box (top-left inside axes)
        self._info = self._ax.text(
            0.02,
            0.97,
            "",
            transform=self._ax.transAxes,
            fontsize=9,
            verticalalignment="top",
            bbox=dict(boxstyle="round,pad=0.3", facecolor="white", alpha=0.7),
        )

        self._fig.tight_layout()
        plt.show(block=False)
        plt.pause(0.01)

    def update(self, generation: int = 0) -> None:
        """Redraws the heatmap with the current state of the archive.

        Call this once per generation inside your evolution loop.

        Args:
            generation: Current generation number (shown in the stats box).
        """
        matrix = _archive_to_matrix(self._archive, self._attr)

        vmin = (
            self._vmin
            if self._vmin is not None
            else np.nanmin(matrix)
            if not np.all(np.isnan(matrix))
            else 0.0
        )
        vmax = (
            self._vmax
            if self._vmax is not None
            else np.nanmax(matrix)
            if not np.all(np.isnan(matrix))
            else 1.0
        )

        self._im.set_data(matrix)
        self._im.set_clim(vmin=vmin, vmax=vmax)

        filled = len(self._archive)
        total = int(self._archive.n_cells)
        coverage = 100 * filled / total if total > 0 else 0.0

        non_nan = matrix[~np.isnan(matrix)]
        mean_p = float(np.mean(non_nan)) if non_nan.size else 0.0
        max_p = float(np.max(non_nan)) if non_nan.size else 0.0

        self._info.set_text(
            f"Generation : {generation}\n"
            f"Cells      : {filled} / {total}  ({coverage:.1f}%)\n"
            f"Mean p     : {mean_p:.4f}\n"
            f"Max  p     : {max_p:.4f}"
        )
        self._fig.canvas.draw()
        self._fig.canvas.flush_events()
        plt.pause(0.001)

    def save(self, path: str, dpi: int = 150) -> None:
        """Saves the current figure to *path*.

        Args:
            path: Output file path (e.g. ``"archive_gen200.png"``).
            dpi:  Resolution. Default 150.
        """
        self._fig.savefig(path, dpi=dpi, bbox_inches="tight")
        print(f"[ArchivePlotter] Saved → {path}")

    def show(self) -> None:
        """Blocks until the figure window is closed (call at end of run)."""
        plt.ioff()
        plt.show()

    def close(self) -> None:
        """Closes the figure programmatically."""
        plt.close(self._fig)

close()

Closes the figure programmatically.

Source code in digneapy/visualize/_archive_plotter.py
228
229
230
def close(self) -> None:
    """Closes the figure programmatically."""
    plt.close(self._fig)

save(path, dpi=150)

Saves the current figure to path.

Parameters:
  • path (str) –

    Output file path (e.g. "archive_gen200.png").

  • dpi (int, default: 150 ) –

    Resolution. Default 150.

Source code in digneapy/visualize/_archive_plotter.py
213
214
215
216
217
218
219
220
221
def save(self, path: str, dpi: int = 150) -> None:
    """Saves the current figure to *path*.

    Args:
        path: Output file path (e.g. ``"archive_gen200.png"``).
        dpi:  Resolution. Default 150.
    """
    self._fig.savefig(path, dpi=dpi, bbox_inches="tight")
    print(f"[ArchivePlotter] Saved → {path}")

show()

Blocks until the figure window is closed (call at end of run).

Source code in digneapy/visualize/_archive_plotter.py
223
224
225
226
def show(self) -> None:
    """Blocks until the figure window is closed (call at end of run)."""
    plt.ioff()
    plt.show()

update(generation=0)

Redraws the heatmap with the current state of the archive.

Call this once per generation inside your evolution loop.

Parameters:
  • generation (int, default: 0 ) –

    Current generation number (shown in the stats box).

Source code in digneapy/visualize/_archive_plotter.py
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
def update(self, generation: int = 0) -> None:
    """Redraws the heatmap with the current state of the archive.

    Call this once per generation inside your evolution loop.

    Args:
        generation: Current generation number (shown in the stats box).
    """
    matrix = _archive_to_matrix(self._archive, self._attr)

    vmin = (
        self._vmin
        if self._vmin is not None
        else np.nanmin(matrix)
        if not np.all(np.isnan(matrix))
        else 0.0
    )
    vmax = (
        self._vmax
        if self._vmax is not None
        else np.nanmax(matrix)
        if not np.all(np.isnan(matrix))
        else 1.0
    )

    self._im.set_data(matrix)
    self._im.set_clim(vmin=vmin, vmax=vmax)

    filled = len(self._archive)
    total = int(self._archive.n_cells)
    coverage = 100 * filled / total if total > 0 else 0.0

    non_nan = matrix[~np.isnan(matrix)]
    mean_p = float(np.mean(non_nan)) if non_nan.size else 0.0
    max_p = float(np.max(non_nan)) if non_nan.size else 0.0

    self._info.set_text(
        f"Generation : {generation}\n"
        f"Cells      : {filled} / {total}  ({coverage:.1f}%)\n"
        f"Mean p     : {mean_p:.4f}\n"
        f"Max  p     : {max_p:.4f}"
    )
    self._fig.canvas.draw()
    self._fig.canvas.flush_events()
    plt.pause(0.001)