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 usage overview docs #76

Merged
merged 17 commits into from
Nov 5, 2021
Merged

Improve usage overview docs #76

merged 17 commits into from
Nov 5, 2021

Conversation

bwohlberg
Copy link
Collaborator

  • Description of inverse problems in Overview section no longer ADMM-specific.
  • Add overview on optimizers to Important Classes section.

@bwohlberg bwohlberg added the documentation Improvements or additions to documentation label Nov 4, 2021
@bwohlberg bwohlberg linked an issue Nov 4, 2021 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Nov 4, 2021

Codecov Report

Merging #76 (9d8453d) into main (ff97e6d) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #76   +/-   ##
=======================================
  Coverage   89.12%   89.12%           
=======================================
  Files          43       43           
  Lines        2978     2978           
=======================================
  Hits         2654     2654           
  Misses        324      324           
Flag Coverage Δ
unittests 89.12% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ff97e6d...9d8453d. Read the comment docs.

docs/source/overview.rst Show resolved Hide resolved
@bwohlberg bwohlberg merged commit 384a2bf into main Nov 5, 2021
@bwohlberg bwohlberg deleted the brendt/docs branch November 5, 2021 02:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs should include an overview of optimization algorithms
3 participants