fix docs

itlubber · Mar 21, 2024 · f6a9c6c · f6a9c6c
1 parent 274a1e9
commit f6a9c6c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/docs/source/scorecardpipeline.rst b/docs/source/scorecardpipeline.rst
@@ -52,7 +52,7 @@ scorecardpipeline.utils
    :show-inheritance:
 
 
-scorecardpipeline.excel\_writer
+scorecardpipeline.excel_writer
 ======================================
 
 .. automodule:: scorecardpipeline.excel_writer
@@ -70,10 +70,19 @@ scorecardpipeline.rule
    :show-inheritance:
 
 
+scorecardpipeline.rule_extraction
+======================================
+
+.. automodule:: scorecardpipeline.rule_extraction
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
 scorecardpipeline.logger
 ======================================
 
 .. automodule:: scorecardpipeline.logger
    :members:
    :undoc-members:
-   :show-inheritance:
+   :show-inheritance:
diff --git a/scorecardpipeline/rule_extraction.py b/scorecardpipeline/rule_extraction.py
@@ -255,7 +255,7 @@ def fit(self, x, y=None, max_depth=2, lift=0., max_samples=1., min_score=None, v
         :param max_samples: 每条组合策略的最大样本占比，默认 1.0，即全部组合策略
         :param min_score: 决策树拟合时最小的auc，如果不满足则停止后续生成决策树
         :param verbose: 是否调试模式，仅在 jupyter 环境有效
-        :param kwargs: DecisionTreeClassifier 参数
+        :param kwargs: DecisionTreeClassifier 参数，参考 https://scikit-learn.org/stable/modules/generated/sklearn.tree.DecisionTreeClassifier.html
         """
         worksheet = self.writer.get_sheet_by_name("策略详情")