Skip to content

Commit

Permalink
consolidated loss function math into API.
Browse files Browse the repository at this point in the history
  • Loading branch information
iancze committed Dec 29, 2023
1 parent 7c9b3a2 commit 4350f95
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 302 deletions.
1 change: 1 addition & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Changelog

## v0.3.0
- Edited documentation to be more concise.
- Added the {meth}`mpol.losses.neg_log_likelihood_avg` method to be used in point-estimate or optimization situations where data amplitudes or weights may be adjusted as part of the optimization (such as via self-calibration).
- Renamed `mpol.losses.nll` -> {meth}`mpol.losses.r_chi_squared` and `mpol.losses.nll_gridded` -> {meth}`mpol.losses.r_chi_squared_gridded` because that is what those routines were previously calculating (see the {ref}`api-reference-label` for more details). ([#237](https://github.com/MPoL-dev/MPoL/issues/237)). Tutorials have also been updated to reflect the change.
- Fixed implementation and docstring of {meth}`mpol.losses.log_likelihood` ([#237](https://github.com/MPoL-dev/MPoL/issues/237)).
Expand Down
11 changes: 9 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,10 @@

autodoc_mock_imports = ["torch", "torchvision"]
autodoc_member_order = "bysource"
autodoc_default_options = {"members": None}
# https://github.com/sphinx-doc/sphinx/issues/9709
# bug that if we set this here, we can't list individual members in the
# actual API doc
# autodoc_default_options = {"members": None}

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand Down Expand Up @@ -94,5 +97,9 @@
nb_execution_raise_on_error = True
# .ipynb are produced using Makefile on own terms,
# # both .md and executed .ipynb are kept in git repo
nb_execution_excludepatterns = ["large-tutorials/*.md", "large-tutorials/*.ipynb", "**.ipynb_checkpoints"]
nb_execution_excludepatterns = [
"large-tutorials/*.md",
"large-tutorials/*.ipynb",
"**.ipynb_checkpoints",
]
myst_heading_anchors = 3
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ If you'd like to help build the MPoL package, please check out the {ref}`develop
:maxdepth: 2
rml_intro.md
introduction.md
installation.md
ci-tutorials/PyTorch
ci-tutorials/gridder
Expand All @@ -38,7 +39,6 @@ large-tutorials/pyro
:caption: API
:maxdepth: 2
api/index
api/coordinates
api/datasets
api/fourier
Expand Down
Loading

0 comments on commit 4350f95

Please sign in to comment.