Skip to content
This repository was archived by the owner on Mar 21, 2024. It is now read-only.

Commit f7c1fc7

Browse files
committed
Expanding abstract method documentation
As per #483 (comment)
1 parent d90c25d commit f7c1fc7

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

InnerEye/ML/deep_learning_config.py

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -303,17 +303,23 @@ def get_cross_validation_hyperdrive_sampler(self) -> GridParameterSampling:
303303
@abstractmethod
304304
def get_cross_validation_hyperdrive_config(self, run_config: ScriptRunConfig) -> HyperDriveConfig:
305305
"""
306-
Is implemented in both ModelConfigBase and LightningContainer
307-
:param run_config: AzureML estimator
308-
:return: HyperDriveConfigs
306+
Returns a configuration for AzureML Hyperdrive that varies the cross validation split index.
307+
308+
This abstract method is implemented in both ModelConfigBase and LightningContainer
309+
:param run_config: The AzureML run configuration object that configures training for an individual model.
310+
:return: A hyperdrive configuration object.
309311
"""
310312
pass
311313

312314
@abstractmethod
313315
def get_parameter_search_hyperdrive_config(self, run_config: ScriptRunConfig) -> HyperDriveConfig:
314316
"""
315-
Is implemented in ModelConfigBase but not in LightningContainer. Classes inheriting
316-
from LightningCountainer may wish to provide an implementation.
317+
Turns the given AzureML estimator (settings for running a job in AzureML) into a configuration object
318+
for doing hyperparameter searches.
319+
320+
This abstract method is implemented in ModelConfigBase but not in LightningContainer. Classes inheriting
321+
from LightningCountainer will wish to provide an implementation if they provide hyper drive support for
322+
parameter search.
317323
:param run_config: AzureML estimator
318324
:return: HyperDriveConfigs
319325
"""

0 commit comments

Comments
 (0)