Update docs and fix tabnet

qlib/contrib/report/analysis_model/analysis_model_performance.py

@@ -252,7 +252,7 @@ def model_performance_graph(
     """Model performance
 
     :param pred_label: index is **pd.MultiIndex**, index name is **[instrument, datetime]**; columns names is **[score,
-    label]**. It is usually same as the label of model training(e.g. "Ref($close, -2)/Ref($close, -1) - 1")
+    label]**. It is usually same as the label of model training(e.g. "Ref($close, -2)/Ref($close, -1) - 1").
 
 
             .. code-block:: python
@@ -266,13 +266,13 @@ def model_performance_graph(
 
 
     :param lag: `pred.groupby(level='instrument')['score'].shift(lag)`. It will be only used in the auto-correlation computing.
-    :param N: group number, default 5
-    :param reverse: if `True`, `pred['score'] *= -1`
-    :param rank: if **True**, calculate rank ic
-    :param graph_names: graph names; default ['cumulative_return', 'pred_ic', 'pred_autocorr', 'pred_turnover']
-    :param show_notebook: whether to display graphics in notebook, the default is `True`
-    :param show_nature_day: whether to display the abscissa of non-trading day
-    :return: if show_notebook is True, display in notebook; else return `plotly.graph_objs.Figure` list
+    :param N: group number, default 5.
+    :param reverse: if `True`, `pred['score'] *= -1`.
+    :param rank: if **True**, calculate rank ic.
+    :param graph_names: graph names; default ['cumulative_return', 'pred_ic', 'pred_autocorr', 'pred_turnover'].
+    :param show_notebook: whether to display graphics in notebook, the default is `True`.
+    :param show_nature_day: whether to display the abscissa of non-trading day.
+    :return: if show_notebook is True, display in notebook; else return `plotly.graph_objs.Figure` list.
     """
     figure_list = []
     for graph_name in graph_names:

qlib/contrib/report/analysis_position/cumulative_return.py

@@ -218,10 +218,10 @@ def cumulative_return_graph(
 
 
         Graph desc:
-            - Axis X: Trading day
+            - Axis X: Trading day.
             - Axis Y:
-            - Above axis Y: `(((Ref($close, -1)/$close - 1) * weight).sum() / weight.sum()).cumsum()`
-            - Below axis Y: Daily weight sum
+            - Above axis Y: `(((Ref($close, -1)/$close - 1) * weight).sum() / weight.sum()).cumsum()`.
+            - Below axis Y: Daily weight sum.
             - In the **sell** graph, `y < 0` stands for profit; in other cases, `y > 0` stands for profit.
             - In the **buy_minus_sell** graph, the **y** value of the **weight** graph at the bottom is `buy_weight + sell_weight`.
             - In each graph, the **red line** in the histogram on the right represents the average.

qlib/contrib/report/analysis_position/rank_label.py

@@ -97,9 +97,9 @@ def rank_label_graph(
                 qcr.rank_label_graph(positions, features_df, pred_df_dates.min(), pred_df_dates.max())
 
 
-    :param position: position data; **qlib.contrib.backtest.backtest.backtest** result
+    :param position: position data; **qlib.contrib.backtest.backtest.backtest** result.
     :param label_data: **D.features** result; index is **pd.MultiIndex**, index name is **[instrument, datetime]**; columns names is **[label]**.
-    **The label T is the change from T to T+1**, it is recommended to use ``close``, example: `D.features(D.instruments('csi500'), ['Ref($close, -1)/$close-1'])`
+    **The label T is the change from T to T+1**, it is recommended to use ``close``, example: `D.features(D.instruments('csi500'), ['Ref($close, -1)/$close-1'])`.
 
 
             .. code-block:: python
@@ -115,7 +115,7 @@ def rank_label_graph(
 
     :param start_date: start date
     :param end_date: end_date
-    :param show_notebook: **True** or **False**. If True, show graph in notebook, else return figures
+    :param show_notebook: **True** or **False**. If True, show graph in notebook, else return figures.
     :return:
     """
     position = copy.deepcopy(position)

qlib/contrib/report/analysis_position/report.py

@@ -186,7 +186,7 @@ def report_graph(report_df: pd.DataFrame, show_notebook: bool = True) -> [list,
 
                 qcr.report_graph(report_normal_df)
 
-    :param report_df: **df.index.name** must be **date**, **df.columns** must contain **return**, **turnover**, **cost**, **bench**
+    :param report_df: **df.index.name** must be **date**, **df.columns** must contain **return**, **turnover**, **cost**, **bench**.
 
 
             .. code-block:: python
@@ -200,8 +200,8 @@ def report_graph(report_df: pd.DataFrame, show_notebook: bool = True) -> [list,
                 2017-01-10  -0.000416   0.000440    -0.003350   0.208396
 
 
-    :param show_notebook: whether to display graphics in notebook, the default is **True**
-    :return: if show_notebook is True, display in notebook; else return **plotly.graph_objs.Figure** list
+    :param show_notebook: whether to display graphics in notebook, the default is **True**.
+    :return: if show_notebook is True, display in notebook; else return **plotly.graph_objs.Figure** list.
     """
     report_df = report_df.copy()
     fig_list = _report_figure(report_df)

qlib/contrib/report/analysis_position/risk_analysis.py

@@ -218,7 +218,7 @@ def risk_analysis_graph(
                                            max_drawdown      -0.088263
 
 
-    :param report_normal_df: **df.index.name** must be **date**, df.columns must contain **return**, **turnover**, **cost**, **bench**
+    :param report_normal_df: **df.index.name** must be **date**, df.columns must contain **return**, **turnover**, **cost**, **bench**.
 
 
             .. code-block:: python
@@ -232,7 +232,7 @@ def risk_analysis_graph(
                 2017-01-10  -0.000416   0.000440    -0.003350   0.208396
 
 
-    :param report_long_short_df: **df.index.name** must be **date**, df.columns contain **long**, **short**, **long_short**
+    :param report_long_short_df: **df.index.name** must be **date**, df.columns contain **long**, **short**, **long_short**.
 
 
             .. code-block:: python
@@ -246,7 +246,7 @@ def risk_analysis_graph(
                 2017-01-10  0.000824    -0.001944   -0.001120
 
 
-    :param show_notebook: Whether to display graphics in a notebook, default **True**
+    :param show_notebook: Whether to display graphics in a notebook, default **True**.
         If True, show graph in notebook
         If False, return graph figure
     :return:

qlib/contrib/report/analysis_position/score_ic.py

@@ -36,7 +36,7 @@ def score_ic_graph(pred_label: pd.DataFrame, show_notebook: bool = True) -> [lis
                 analysis_position.score_ic_graph(pred_label)
 
 
-    :param pred_label: index is **pd.MultiIndex**, index name is **[instrument, datetime]**; columns names is **[score, label]**
+    :param pred_label: index is **pd.MultiIndex**, index name is **[instrument, datetime]**; columns names is **[score, label]**.
 
 
             .. code-block:: python
@@ -49,8 +49,8 @@ def score_ic_graph(pred_label: pd.DataFrame, show_notebook: bool = True) -> [lis
                             2017-12-15   -0.102778       -0.102778
 
 
-    :param show_notebook: whether to display graphics in notebook, the default is **True**
-    :return: if show_notebook is True, display in notebook; else return **plotly.graph_objs.Figure** list
+    :param show_notebook: whether to display graphics in notebook, the default is **True**.
+    :return: if show_notebook is True, display in notebook; else return **plotly.graph_objs.Figure** list.
     """
     _ic_df = _get_score_ic(pred_label)
     # FIXME: support HIGH-FREQ