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

Add Optuna Documentation and Pre-Optimized Configuration Parameters #402

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

timsmsmsm
Copy link

This draft pull request adds several .rst files to the btrack documentation. These files are currently in progress and, when completed, will provide comprehensive guidance on how to use the optuna package to optimize btrack config parameters for any appropriately annotated cell microscopy dataset.

The new documentation will include a section that guides users on how to use an annotated portion of their data to optimize parameters based on this annotated data, and apply these optimized parameters to their unannotated data. This approach should theoretically yield parameters that are effective for the entire dataset.

In addition to the optuna usage guide, this pull request will also introduce a file containing pre-optimized parameters for various datasets from the Cell Tracking Challenge. This file will include details about each dataset, enabling users with similar data to use these pre-optimized parameters as a starting point.

Please note that the added .rst files are still under development

Checklist

  • decide if example optuna script should stay in examples subdirectory
  • Complete guide to use optuna script
  • Add pre-optimized parameters for Cell Tracking Challenge datasets
  • Add information about parameter importance for each dataset
  • Add descriptions and info for each dataset
  • potentially add analysis of which correlation between dataset features and which parameters are most important

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.58%. Comparing base (40d98b8) to head (fd09a3d).
Report is 7 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #402      +/-   ##
==========================================
- Coverage   85.70%   85.58%   -0.12%     
==========================================
  Files          31       31              
  Lines        2203     2206       +3     
  Branches      404      405       +1     
==========================================
  Hits         1888     1888              
- Misses        233      235       +2     
- Partials       82       83       +1     

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants