AlgorithmProfile
Data structures for algorithm performance profiles.
Contains AlgorithmProfile and related classes for characterizing algorithm strengths, weaknesses, and optimal parameters.
See ADR-011 for architecture decisions.
Classes
- class PerformanceMetrics
Performance metrics for an algorithm.
Methods:
- to_dict()
Convert to dictionary.
- class OptimalPreset
Optimal parameter preset for an algorithm.
Methods:
- to_dict()
Convert to dictionary.
- class ExampleScreenshot
Reference to an example screenshot.
Methods:
- to_dict()
Convert to dictionary.
- class AlgorithmProfile
Complete profile for a segmentation algorithm.
Contains performance metrics, optimal parameters, strengths, weaknesses, and use case recommendations.
- Example:
- profile = AlgorithmProfile(
algorithm=”watershed”, display_name=”Watershed”, performance=PerformanceMetrics(best_dice=1.0, mean_dice=0.95), optimal_preset=OptimalPreset(params={“edge_sensitivity”: 40}), strengths=[“Perfect Dice achievable”, “Good boundary adherence”], weaknesses=[“Medium speed”], best_for=[“General-purpose segmentation”], avoid_for=[“Speed-critical applications”],
)
Methods:
- to_dict()
Convert to dictionary for JSON serialization.
- from_dict()
Create profile from dictionary.
- get_summary()
Get one-line summary of algorithm.
- class AlgorithmComparison
Comparison of multiple algorithms.
Methods:
- to_dict()
Convert to dictionary.
- from_dict()
Create comparison from dictionary.
- get_best_for_dice()
Get algorithm with best mean Dice.
- get_fastest()
Get fastest algorithm.
- get_most_efficient()
Get most click-efficient algorithm.
Functions
- to_dict()
Convert to dictionary.
- to_dict()
Convert to dictionary.
- to_dict()
Convert to dictionary.
- to_dict()
Convert to dictionary for JSON serialization.
- from_dict()
Create profile from dictionary.
- get_summary()
Get one-line summary of algorithm.
- to_dict()
Convert to dictionary.
- from_dict()
Create comparison from dictionary.
- get_best_for_dice()
Get algorithm with best mean Dice.
- get_fastest()
Get fastest algorithm.
- get_most_efficient()
Get most click-efficient algorithm.
- get_display_name()
Get human-readable name for algorithm.
- Args:
algorithm: Internal algorithm name.
- Returns:
Display name.