fix(eda):wordcloud setting in terminal

sfu-db · Dec 21, 2021 · 0090169 · 0090169 · github-actions · Dec 21, 2021
1 parent 67500b5
commit 0090169
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/dataprep/eda/configs.py b/dataprep/eda/configs.py
@@ -20,8 +20,9 @@
 from __future__ import annotations
 
 from typing import Any, Dict, List, Optional, Tuple, Union
-
 from pydantic import BaseModel, Field
+from ..utils import is_notebook
+
 
 # This dictionary map the plot names in display to their canonicalized names in Config
 DISPLAY_MAP = {
@@ -465,7 +466,7 @@ class WordCloud(BaseModel):
         Whether to apply Potter Stem on the words
     """
 
-    enable: bool = True
+    enable: bool = is_notebook()
     top_words: int = 30
     stopword: bool = True
     lemmatize: bool = False

diff --git a/docs/source/user_guide/eda/parameter_configurations.ipynb b/docs/source/user_guide/eda/parameter_configurations.ipynb
@@ -105,7 +105,7 @@
     "| `pie.slices`| int | 10 | Maximum number of pie slices to display in the `Pie Chart`|\n",
     "| `pie.sort_descending`| bool | True | Whether to sort the slices in descending order of frequency in the `Pie Chart`|\n",
     "| `pie.colors` | List[str] | None | Colors of the slices in the `Pie Chart` |\n",
-    "| `wordcloud.enable` | bool | True | Whether enable `Word Cloud` |\n",
+    "| `wordcloud.enable` | bool | is_notebook | Whether enable `Word Cloud`. Default True if it's in notebook environment, else False |\n",
     "| `wordcloud.height` | int | None | The height of the `Word Cloud`|\n",
     "| `wordcloud.width` | int | None | The width of the `Word Cloud` |\n",
     "| `wordcloud.top_words`| int | 30 | Maximum number of most frequent words to display in the `Word Cloud`|\n",
@@ -204,7 +204,7 @@
     "| `pie.enable` | bool | True | Whether enable `Pie Chart` |\n",
     "| `pie.slices`| int | 10 | Maximum number of pie slices to display in the `Pie Chart`|\n",
     "| `pie.sort_descending`| bool | True | Whether to sort the slices in descending order of frequency in the `Pie Chart`|\n",
-    "| `wordcloud.enable` | bool | True | Whether enable `Word Cloud` |\n",
+    "| `wordcloud.enable` | bool | is_notebook | Whether enable `Word Cloud`. Default True if it's in notebook environment, else False |\n",
     "| `wordcloud.top_words`| int | 30 | Maximum number of most frequent words to display in the `Word Cloud`|\n",
     "| `wordcloud.stopword`| bool | True | Whether to remove stopwords in the `Word Cloud`|\n",
     "| `wordcloud.lemmatize`| bool | False |  Whether to lemmatize the words in the `Word Cloud`|\n",