Skip to content

Commit 5c6933c

Browse files
authored
doc: add summary on functions (#73)
1 parent 14171a5 commit 5c6933c

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/parameters.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
Parameters
22
==========
33

4-
This page provides the API reference of :mod:`torchensemble`.
4+
This page provides the API reference of :mod:`torchensemble`. Below is a list of functions supported by all ensembles.
5+
6+
* :meth:`fit`: Training stage of the ensemble
7+
* :meth:`evaluate`: Evaluating stage of the ensemble
8+
* :meth:`predict`: Return the predictions of the ensemble
9+
* :meth:`forward`: Data forward process of the ensemble
10+
* :meth:`set_optimizer`: Set the parameter optimizer for training the ensemble
11+
* :meth:`set_scheduler`: Set the learning rate scheduler for training the ensemble
512

613
Fusion
714
------

0 commit comments

Comments
 (0)