Document behavior of get_fscore() for zero-importance features (#3763)

2018-10-08 01:52:25 -07:00 · 2018-10-08 01:52:25 -07:00 · ea99b53d8e
commit ea99b53d8e
parent 10cd7c8447
1 changed files with 5 additions and 0 deletions
--- a/python-package/xgboost/core.py
+++ b/python-package/xgboost/core.py
@ -1395,6 +1395,11 @@ class Booster(object):
            learner (`booster=gbtree`). It is not defined for other base learner types, such
            as linear learners (`booster=gblinear`).

+        .. note:: Zero-importance features will not be included
+
+           Keep in mind that this function does not include zero-importance feature, i.e.
+           those features that have not been used in any split conditions.
+
        Parameters
        ----------
        fmap: str (optional)