Skip to content

Commit

Permalink
Fix link to GradientOptBase (#333)
Browse files Browse the repository at this point in the history
## Description

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

Fixing a simple broken link.

## 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 17, 2023
1 parent 900868b commit 822e8bb
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions ribs/emitters/_gradient_arborescence_emitter.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ class GradientArborescenceEmitter(EmitterBase):
archive.
grad_opt (Callable or str): Gradient optimizer to use for the gradient
ascent step of the algorithm. The optimizer is a
:class:`GradientOptBase` object. This parameter may be a callable
(e.g. a class or a lambda function) which takes in the ``theta0``
and ``lr`` arguments, or it may be a full or abbreviated name as
described in :mod:`ribs.emitters.opt`.
:class:`~ribs.emitters.opt.GradientOptBase` object. This parameter
may be a callable (e.g. a class or a lambda function) which takes in
the ``theta0`` and ``lr`` arguments, or it may be a full or
abbreviated name as described in :mod:`ribs.emitters.opt`.
grad_opt_kwargs (dict): Additional arguments to pass to the gradient
optimizer. See the gradient-based optimizers in
:mod:`ribs.emitters.opt` for the arguments allowed by each
Expand Down

0 comments on commit 822e8bb

Please sign in to comment.