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

Improvement to landscape plots, MCMC summary, x0 log entry #570

Merged
merged 7 commits into from
Dec 4, 2024

Conversation

BradyPlanden
Copy link
Member

@BradyPlanden BradyPlanden commented Nov 27, 2024

Description

  • Updates to MCMC summary class
  • Update to contour and surface plots
  • Adds x0 as optim.log entry

Issue reference

Fixes #235

Review

Before you mark your PR as ready for review, please ensure that you've considered the following:

  • Updated the CHANGELOG.md in reverse chronological order (newest at the top) with a concise description of the changes, including the PR number.
  • Noted any breaking changes, including details on how it might impact existing functionality.

Type of change

  • New Feature: A non-breaking change that adds new functionality.
  • Optimization: A code change that improves performance.
  • Examples: A change to existing or additional examples.
  • Bug Fix: A non-breaking change that addresses an issue.
  • Documentation: Updates to documentation or new documentation for new features.
  • Refactoring: Non-functional changes that improve the codebase.
  • Style: Non-functional changes related to code style (formatting, naming, etc).
  • Testing: Additional tests to improve coverage or confirm functionality.
  • Other: (Insert description of change)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All unit tests pass: $ nox -s tests
  • The documentation builds: $ nox -s doctest

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

  • Code is well-commented, especially in complex or unclear areas.
  • Added tests that prove my fix is effective or that my feature works.
  • Checked that coverage remains or improves, and added tests if necessary to maintain or increase coverage.

Thank you for contributing to our project! Your efforts help us to deliver great software.

@BradyPlanden
Copy link
Member Author

Below are the updated landscape plots, the following changes have been made:

  • The optimisation trace colouring has been changed to greyscale
  • The contour colourscale has been changed to Viridis to align with the surface plot
  • Initial and final values are added via crosses (colour matching the optim trace) with entries in the legend.

contour
surface

Open to suggestions for improvements, just drop a comment 😃

Copy link

codecov bot commented Nov 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.15%. Comparing base (c8b00e6) to head (8c6c8f9).
Report is 26 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #570      +/-   ##
===========================================
+ Coverage    99.08%   99.15%   +0.07%     
===========================================
  Files           52       56       +4     
  Lines         3605     3918     +313     
===========================================
+ Hits          3572     3885     +313     
  Misses          33       33              

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

@BradyPlanden BradyPlanden added the show This PR will be merged without review label Dec 4, 2024
@BradyPlanden BradyPlanden merged commit d70408c into develop Dec 4, 2024
31 checks passed
@BradyPlanden BradyPlanden deleted the mcmc-summary-updates branch December 4, 2024 10:40
BradyPlanden added a commit that referenced this pull request Dec 4, 2024
BradyPlanden added a commit that referenced this pull request Dec 4, 2024
@BradyPlanden BradyPlanden mentioned this pull request Dec 4, 2024
15 tasks
BradyPlanden added a commit that referenced this pull request Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
show This PR will be merged without review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improving cost function plotting?
1 participant