Skip to content

Comments

Increase maximum_iterations parameter to 100#386

Merged
tsmbland merged 3 commits intodocumentationfrom
max_iterations
Jul 2, 2024
Merged

Increase maximum_iterations parameter to 100#386
tsmbland merged 3 commits intodocumentationfrom
max_iterations

Conversation

@tsmbland
Copy link
Collaborator

@tsmbland tsmbland commented Jul 1, 2024

Description

The example models were previously using a range of values for the maximum_iterations parameter, ranging from 1 to 100. As explained in the issue (#372), this should be a high number, so I've changed all the models to use 100 and regenerated the results files.

I've also changed the default value from 3 to 100 (i.e. when not specified in the settings file)

I've based this PR off #349 as that one is already changing all the results files. There may be some text changes required in the notebooks (e.g. describing plots), but I'll address these sorts of things in #349 once this is merged

Fixes #372

Type of change

Please add a line in the relevant section of
CHANGELOG.md to
document the change (include PR #) - note reverse order of PR #s.

  • New feature (non-breaking change which adds functionality)
  • Optimization (non-breaking, back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (whatever its nature)

Key checklist

  • All tests pass: $ python -m pytest
  • The documentation builds and looks OK: $ python -m sphinx -b html docs docs/build

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@tsmbland tsmbland changed the title Increase max_iterations parameter to 100 Increase maximum_iterations parameter to 100 Jul 1, 2024
@codecov
Copy link

codecov bot commented Jul 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.25%. Comparing base (7f14883) to head (d4ef25b).

Additional details and impacted files
@@                Coverage Diff                @@
##           documentation     #386      +/-   ##
=================================================
- Coverage          71.36%   71.25%   -0.11%     
=================================================
  Files                 44       44              
  Lines               5901     5901              
  Branches            1166     1166              
=================================================
- Hits                4211     4205       -6     
- Misses              1370     1374       +4     
- Partials             320      322       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tsmbland tsmbland linked an issue Jul 1, 2024 that may be closed by this pull request
@tsmbland tsmbland marked this pull request as ready for review July 1, 2024 20:02
@tsmbland tsmbland requested review from alexdewar and dalonsoa July 1, 2024 20:03
Copy link
Collaborator

@dalonsoa dalonsoa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks sensible to me. It's interesting to see how the output files change, adding more assets installed in the future years. I hope those changes still make sense!

Copy link
Collaborator

@alexdewar alexdewar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@tsmbland tsmbland merged commit 5a82c7a into documentation Jul 2, 2024
@tsmbland tsmbland deleted the max_iterations branch July 2, 2024 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

maximum_iterations value for the example/tutorial models?

3 participants