Merge pull request #840 from dianna-ai/fix_822

Fix docstring of visualization tabular

dianna/visualization/tabular.py

@@ -18,7 +18,7 @@ def plot_tabular(
     """Plot feature importance with segments highlighted.
 
     Args:
-        x (np.ndarray): Array of feature importance scores
+        x (np.ndarray): 1D array of feature importance scores of one instance
         y (List[str]): List of feature names
         x_label (str): Label for the x-axis
         y_label (str): Label or list of labels for the y-axis
@@ -32,6 +32,12 @@ def plot_tabular(
     Returns:
         plt.Figure
     """
+    # check type and shape of x should be 1D array
+    if not isinstance(x, np.ndarray):
+        raise TypeError("x should be a numpy array")
+    if x.ndim != 1:
+        raise ValueError("x should be a 1D array")
+
     if not num_features:
         num_features = len(x)
     abs_values = [abs(i) for i in x]

tests/test_visualization.py

@@ -18,6 +18,14 @@ def test_plot_tabular(tmpdir):
 
     assert output_path.exists()
 
+def test_plot_tabular_with_ndarray():
+    """Test plot tabular data with ndarray."""
+    x = np.random.rand(5, 3)
+    y = [f"Feature {i}" for i in range(x.shape[1])]
+    # check ValueError
+    with pytest.raises(ValueError):
+        plot_tabular(x=x, y=y, show_plot=False)
+
 
 def test_plot_timeseries_univariate(tmpdir, random):
     """Test plot univariate time series."""