From 5c6933c48d04799a2e3daa7ea2415dbbf6a1853e Mon Sep 17 00:00:00 2001 From: Yi-Xuan Xu Date: Mon, 17 May 2021 13:40:32 +0800 Subject: [PATCH] doc: add summary on functions (#73) --- docs/parameters.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/parameters.rst b/docs/parameters.rst index 554721c..b256840 100644 --- a/docs/parameters.rst +++ b/docs/parameters.rst @@ -1,7 +1,14 @@ Parameters ========== -This page provides the API reference of :mod:`torchensemble`. +This page provides the API reference of :mod:`torchensemble`. Below is a list of functions supported by all ensembles. + +* :meth:`fit`: Training stage of the ensemble +* :meth:`evaluate`: Evaluating stage of the ensemble +* :meth:`predict`: Return the predictions of the ensemble +* :meth:`forward`: Data forward process of the ensemble +* :meth:`set_optimizer`: Set the parameter optimizer for training the ensemble +* :meth:`set_scheduler`: Set the learning rate scheduler for training the ensemble Fusion ------