btrack icon indicating copy to clipboard operation
btrack copied to clipboard

Add Optuna Documentation and Pre-Optimized Configuration Parameters

Open timsmsmsm opened this issue 4 months ago • 1 comments

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

timsmsmsm avatar Mar 05 '24 01:03 timsmsmsm