Skip to content

Commit 397dec1

Browse files
committed
docs: new documentation on ensemble training
1 parent d63c1dc commit 397dec1

6 files changed

Lines changed: 650 additions & 26 deletions

File tree

docs/source/api.rst

Lines changed: 55 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,63 @@ Locator
2424
:show-inheritance:
2525

2626

27-
Ensemble Module
28-
---------------
29-
.. module:: locator.ensemble
27+
Ensemble Functionality
28+
----------------------
3029

31-
EnsembleLocator
32-
^^^^^^^^^^^^^^^
33-
.. autoclass:: EnsembleLocator
30+
The ensemble functionality is integrated into the main ``Locator`` class through the ``EnsembleMixin``.
31+
32+
.. module:: locator.ensemble_mixin
33+
34+
EnsembleMixin
35+
^^^^^^^^^^^^^
36+
.. autoclass:: EnsembleMixin
37+
:members:
38+
:show-inheritance:
39+
40+
Key methods for ensemble training and prediction:
41+
42+
.. automethod:: train_ensemble
43+
.. automethod:: predict_ensemble
44+
.. automethod:: load_ensemble
45+
.. automethod:: predict_ensemble_from_manager
46+
47+
.. module:: locator.ensemble_model_manager
48+
49+
EnsembleModelManager
50+
^^^^^^^^^^^^^^^^^^^^
51+
.. autoclass:: EnsembleModelManager
3452
:members:
53+
:show-inheritance:
54+
55+
Efficient storage and loading of ensemble models.
56+
57+
Parallel Ensemble Training
58+
^^^^^^^^^^^^^^^^^^^^^^^^^^
59+
.. module:: locator.parallel.parallel_analysis
60+
61+
.. autofunction:: parallel_train_ensemble
62+
63+
Train ensemble models in parallel across multiple GPUs.
64+
65+
Args:
66+
locator: Locator instance with configuration
67+
genotypes: GenotypeArray containing genetic data
68+
samples: Array of sample IDs
69+
k: Number of folds/models in ensemble (default: 5)
70+
gpu_ids: List of GPU IDs to use (default: [0, 1])
71+
gpu_fraction: Fraction of GPU memory per worker (default: 1.0)
72+
training_set_indices: Optional indices to restrict training
73+
na_action: How to handle NA samples ('separate', 'exclude', 'fail')
74+
augment_data: Whether to apply data augmentation
75+
flip_rate: Rate for genotype flipping augmentation
76+
save_fold_models: Whether to save individual fold models
77+
use_model_manager: Whether to use model manager for storage
78+
use_mixed_precision: Whether to use mixed precision training
79+
patience_multiplier: Multiply patience for ensemble training
80+
verbose: Whether to show training progress
81+
82+
Returns:
83+
dict: Contains histories, models, normalization_params, fold_info
3584

3685

3786

0 commit comments

Comments
 (0)