Replace batch arguments in rankers with data and add_info - Githubissues

icaros-usc / pyribs

A bare-bones Python library for quality diversity optimization.

https://pyribs.org

MIT License

208 stars 34 forks source link

Replace batch arguments in rankers with data and add_info #428

Closed btjanaka closed 10 months ago

btjanaka commented 10 months ago

Description

To simplify ranker signatures, this PR switches them to use data and add_info arguments instead of batch arguments.

This PR also removes the private _docstrings module, as it was only used in the rankers.

TODO

[x] Change rank() method signature
[x] Update usage in emitters
[x] Update rank tests
[x] Remove _docstrings module

Questions

Status

[x] I have read the guidelines in CONTRIBUTING.md
[x] I have formatted my code using yapf
[x] I have tested my code by running pytest
[x] I have linted my code with pylint
[x] I have added a one-line description of my change to the changelog in HISTORY.md
[x] This PR is ready to go