From 24cc5e6694e49ca5391fd5ecd0e25d403e6ba836 Mon Sep 17 00:00:00 2001 From: Gao Enhao Date: Tue, 12 Dec 2023 21:58:10 +0800 Subject: [PATCH] [MNT] resolve comments in Bridge.rst --- docs/Intro/Bridge.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/Intro/Bridge.rst b/docs/Intro/Bridge.rst index c645cbf..45f5a21 100644 --- a/docs/Intro/Bridge.rst +++ b/docs/Intro/Bridge.rst @@ -51,6 +51,18 @@ The fundamental part of the ``train`` method is as follows: .. code-block:: python def train(self, train_data, loops=50, segment_size=10000): + """ + Parameters + ---------- + train_data : Tuple[List[List[Any]], Optional[List[List[Any]]], List[Any]]] + Training data. + loops : int + Machine Learning part and Reasoning part will be iteratively optimized + for ``loops`` times. + segment_size: + Data will be split into segments of this size and data in each segment + will be used together to train the model. + """ if isinstance(train_data, ListData): data_samples = train_data else: