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.

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

Improve example scripts #228

Open
5 of 7 tasks
bwohlberg opened this issue Feb 23, 2022 · 0 comments
Open
5 of 7 tasks

Improve example scripts #228

bwohlberg opened this issue Feb 23, 2022 · 0 comments
Assignees
Labels
examples Pertaining to SCICO examples

Comments

@bwohlberg
Copy link
Collaborator

bwohlberg commented Feb 23, 2022

The example scripts could do with improvement on a number of fronts

  • Where isotropic TV is used, change regularization term notation from ||Cx||_1 to ||Cx||_{2,1}.
  • Script (and corresponding notebook) names could be simplified (e.g. does the iso in some TV examples really play a useful role?).
  • Script titles could be more consistent (e.g. most include details such as optimizer used in parentheses, but some do not).
  • Some of the scripts have excessively brief initial descriptions of the purpose of the example.
  • Greater consistency in the initial descriptions would be desirable (e.g. always provide both the functional being minimized and link(s) to relevant scico classes).
  • More detail could be provided in setting up the functionals to be solved, and it would also be helpful to explain the choice of optimization algorithm.
  • Some script names and titles could be improved (e.g. "Isotropic Total Variation" actually compares isotropic and anisotropic forms).
@bwohlberg bwohlberg added the examples Pertaining to SCICO examples label Feb 23, 2022
@bwohlberg bwohlberg added this to the Release 0.0.3 milestone Jul 1, 2022
@Michael-T-McCann Michael-T-McCann assigned bwohlberg and unassigned tbalke Sep 12, 2022
bwohlberg added a commit that referenced this issue Sep 14, 2022
* Fix docs math for isotropic TV

* Correct docs on isotropic/anisotripic

* Correct example title

* Improve some titles and header descriptions

* Minor edit

* Rename example

* Correct example title

* Clean up titles and header descriptions

* Update example index

* Move significant functions to a separate module

* Fix imports

* Add script to update notebook markdown without re-run

* Update readme

* Avoid duplicate label warnings

* Re-arrange examples in index

* Clean up titles and header descriptions

* Updated example index

* Update submodule

* Modify index and simplify some titles

* Fix bug in notebook build functions

* Update submodule

* Update submodule

* Update index

* Improve index order

* Improve index order

* Update submodule

* Changes in response to PR review

* Update submodule

* Update index

* Update submodule
bwohlberg added a commit to lanl/scico-data that referenced this issue Sep 14, 2022
* Fix docs math and description for isotropic TV

* Correct example title

* Rename example

* Correct example title

* Update markdown from source scripts

* Update markdown from source scripts

* Rerun notebooks

* Remove bad notebook

* Update notebooks from scripts

* Rebuild notebook

* Update index

* Update notebooks from scripts

* Update index

Co-authored-by: Brendt Wohlberg <[email protected]>
@bwohlberg bwohlberg removed this from the Release 0.0.3 milestone Sep 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
examples Pertaining to SCICO examples
Projects
None yet
Development

No branches or pull requests

3 participants