icaros-usc / pyribs

A bare-bones Python library for quality diversity optimization.
https://pyribs.org
MIT License
208 stars 32 forks source link

Rename elites_with_measures to retrieve #295

Closed btjanaka closed 1 year ago

btjanaka commented 1 year ago

Description

elites_with_measures and elites_with_measures_single is a very long name. retrieve is much more succinct.

While the name may be more vague, we think this is okay because we review the method in the lunar lander tutorial. Furthermore, the usage makes the meaning very clear; e.g., elite_batch = archive.retrieve(measures_batch).

We also considered the name find but find implies a search, which is not what this method is doing. This method is merely retrieving the elite at a given cell, not searching the archive to find an elite with the given measures.

TODO

Questions

Status