quantumjot / btrack

Bayesian multi-object tracking
https://btrack.readthedocs.io
MIT License
310 stars 50 forks source link

Add Optuna Documentation and Pre-Optimized Configuration Parameters #402

Open timsmsmsm opened 4 months ago

timsmsmsm commented 4 months ago

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

codecov-commenter commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

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

Additional details and impacted files ```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.