Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Dependencies for examples #195

Closed
bwohlberg opened this issue Jan 28, 2022 · 0 comments · Fixed by #209
Closed

Dependencies for examples #195

bwohlberg opened this issue Jan 28, 2022 · 0 comments · Fixed by #209
Labels
developer Developer environment: issues related to CI, git, etc. documentation Improvements or additions to documentation

Comments

@bwohlberg
Copy link
Collaborator

Some notes on installing example dependencies have been added to docs/source/examples.rst. Since this file is auto-generated by examples/makeindex.py, they are removed whenever the index is update. Obvious solutions are either:

  1. move the notes to a different file, or
  2. include them in the examples/makeindex.py script.
@bwohlberg bwohlberg added documentation Improvements or additions to documentation developer Developer environment: issues related to CI, git, etc. labels Jan 28, 2022
@bwohlberg bwohlberg mentioned this issue Feb 4, 2022
Merged
bwohlberg added a commit that referenced this issue Feb 4, 2022
@bwohlberg
Include example depencies instructions, resolve #195
b2aa9dc
@bwohlberg bwohlberg linked a pull request Feb 4, 2022 that will close this issue
Improve ray.tune usage example. #209
Merged
bwohlberg added a commit that referenced this issue Feb 4, 2022
@bwohlberg
Improve ray.tune usage example. (#209)
3ff6945 
* Add missing script header

* Header docstring improvement

* Make plotting compatible with automatic notebook generation

* Improve result record name

* Change default result directory

* Add deconv_tv_admm_tune.py to examples index

* Clean up

* Improve tests

* Change tune configuration

* Update submodule

* Include example dependency instructions, resolve #195

* Correct comment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
developer Developer environment: issues related to CI, git, etc. documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve ray.tune usage example. lanl/scico
1 participant
@bwohlberg