--- a +++ b/docs-source/source/model.rst @@ -0,0 +1,53 @@ +.. currentmodule:: slideflow.model + +slideflow.model +=============== + +This module provides the :class:`ModelParams` class to organize model and training +parameters/hyperparameters and assist with model building, as well as the :class:`Trainer` class that +executes model training and evaluation. :class:`RegressionTrainer` and :class:`SurvivalTrainer` +are extensions of this class, supporting regression and Cox Proportional Hazards outcomes, respectively. The function +:func:`build_trainer` can choose and return the correct model instance based on the provided +hyperparameters. + +.. note:: + In order to support both Tensorflow and PyTorch backends, the :mod:`slideflow.model` module will import either + :mod:`slideflow.model.tensorflow` or :mod:`slideflow.model.torch` according to the currently active backend, + indicated by the environmental variable ``SF_BACKEND``. + +See :ref:`training` for a detailed look at how to train models. + +Trainer +******* +.. autoclass:: Trainer +.. autofunction:: slideflow.model.Trainer.load +.. autofunction:: slideflow.model.Trainer.evaluate +.. autofunction:: slideflow.model.Trainer.predict +.. autofunction:: slideflow.model.Trainer.train + +RegressionTrainer +***************** +.. autoclass:: RegressionTrainer + +SurvivalTrainer +*************** +.. autoclass:: SurvivalTrainer + +Features +******** +.. autoclass:: Features +.. autofunction:: slideflow.model.Features.from_model +.. autofunction:: slideflow.model.Features.__call__ + +Other functions +*************** +.. autofunction:: build_trainer +.. autofunction:: build_feature_extractor +.. autofunction:: list_extractors +.. autofunction:: load +.. autofunction:: is_tensorflow_model +.. autofunction:: is_tensorflow_tensor +.. autofunction:: is_torch_model +.. autofunction:: is_torch_tensor +.. autofunction:: read_hp_sweep +.. autofunction:: rebuild_extractor \ No newline at end of file