Skip to content

Commit

Permalink
Add note about k-D tree implementation (#334)
Browse files Browse the repository at this point in the history
## Description

<!-- Provide a brief description of the PR's purpose here. -->

Small note to memorialize our choice of scipy's k-D tree over sklearn's
k-D tree.

## TODO

<!-- Notable points that this PR has either accomplished or will
accomplish. -->

## Questions

<!-- Any concerns or points of confusion? -->

## Status

- [x] I have read the guidelines in
[CONTRIBUTING.md](https://github.com/icaros-usc/pyribs/blob/master/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`
- [ ] ~I have added a one-line description of my change to the changelog
in `HISTORY.md`~
- [x] This PR is ready to go
  • Loading branch information
btjanaka committed Mar 22, 2023
1 parent 822e8bb commit e02dd90
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions ribs/archives/_cvt_archive.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@ class CVTArchive(ArchiveBase):
<../../tutorials/cma_mae.html>`_ for more info on thresholds, including
the ``learning_rate`` and ``threshold_min`` parameters.
.. note:: For more information on our choice of k-D tree implementation, see
`#38 <https://github.com/icaros-usc/pyribs/issues/38>`_.
Args:
solution_dim (int): Dimension of the solution space.
cells (int): The number of cells to use in the archive, equivalent to
Expand Down

0 comments on commit e02dd90

Please sign in to comment.