Skip to content

Commit

Permalink
added release notes. fixed typo in docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Kieran-Fishwick-TfN committed Jan 9, 2025
1 parent 55b54e2 commit b5e42e8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,6 @@ there.
Below, a brief summary of patches made since the previous version can be found.

### Next Release Notes
- Multi-TLD gravity model added
- Removed gravity_model.GravityModelRunResults and gravity_model.GravityModelCalibrateResults.
GravityModelResults contains their functionality has been/should be used in leu of the removed classes.

2 changes: 1 addition & 1 deletion src/caf/distribute/gravity_model/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class GravityModelResults:
cost_distribution: cost_utils.CostDistribution
"""The achieved cost distribution of the results."""
target_cost_distribution: cost_utils.CostDistribution
"""The taregt cost distribution used to obtain the results."""
"""The target cost distribution used to obtain the results."""
cost_convergence: float
"""The achieved cost convergence value of the run. If
`target_cost_distribution` is not set, then this should be 0.
Expand Down

0 comments on commit b5e42e8

Please sign in to comment.