dataeval 0.72.0__py3-none-any.whl → 0.72.1__py3-none-any.whl

dataeval/_internal/metrics/coverage.py

@@ -16,7 +16,7 @@ from dataeval._internal.output import OutputMetadata, set_metadata
 @dataclass(frozen=True)
 class CoverageOutput(OutputMetadata):
     """
-    Output class for :func:`coverage` bias metric
+    Output class for :func:`coverage` :term:`bias<Bias>` metric
 
     Attributes
     ----------
@@ -25,7 +25,7 @@ class CoverageOutput(OutputMetadata):
     radii : NDArray
         Array of critical value radii
     critical_value : float
-        Radius for coverage
+        Radius for :term:`coverage<Coverage>`
     """
 
     indices: NDArray[np.intp]
@@ -41,7 +41,7 @@ def coverage(
     percent: np.float64 = np.float64(0.01),
 ) -> CoverageOutput:
     """
-    Class for evaluating coverage and identifying images/samples that are in undercovered regions.
+    Class for evaluating :term:`coverage<Coverage>` and identifying images/samples that are in undercovered regions.
 
     Parameters
     ----------
@@ -64,7 +64,7 @@ def coverage(
     Raises
     ------
     ValueError
-        If length of embeddings is less than or equal to k
+        If length of :term:`embeddings<Embeddings>` is less than or equal to k
     ValueError
         If radius_type is unknown
 

dataeval/_internal/metrics/divergence.py

@@ -1,5 +1,5 @@
 """
-This module contains the implementation of HP Divergence
+This module contains the implementation of HP :term:`divergence<Divergence>`
 using the Fast Nearest Neighbor and Minimum Spanning Tree algorithms
 """
 
@@ -24,7 +24,7 @@ class DivergenceOutput(OutputMetadata):
     Attributes
     ----------
     divergence : float
-        Divergence value calculated between 2 datasets ranging between 0.0 and 1.0
+        :term:`Divergence` value calculated between 2 datasets ranging between 0.0 and 1.0
     errors : int
         The number of differing edges between the datasets
     """
@@ -82,7 +82,7 @@ DIVERGENCE_FN_MAP = {"FNN": divergence_fnn, "MST": divergence_mst}
 @set_metadata("dataeval.metrics")
 def divergence(data_a: ArrayLike, data_b: ArrayLike, method: Literal["FNN", "MST"] = "FNN") -> DivergenceOutput:
     """
-    Calculates the divergence and any errors between the datasets
+    Calculates the :term`divergence` and any errors between the datasets
 
     Parameters
     ----------
@@ -93,7 +93,7 @@ def divergence(data_a: ArrayLike, data_b: ArrayLike, method: Literal["FNN", "MST
         A dataset in an ArrayLike format to compare.
         Function expects the data to have 2 dimensions, N number of observations in a P-dimensionial space.
     method : Literal["MST, "FNN"], default "FNN"
-        Method used to estimate dataset divergence
+        Method used to estimate dataset :term:`divergence<Divergence>`
 
     Returns
     -------

dataeval/_internal/metrics/diversity.py

@@ -13,12 +13,12 @@ from dataeval._internal.output import OutputMetadata, set_metadata
 @dataclass(frozen=True)
 class DiversityOutput(OutputMetadata):
     """
-    Output class for :func:`diversity` bias metric
+    Output class for :func:`diversity` :term:`bias<Bias>` metric
 
     Attributes
     ----------
     diversity_index : NDArray[np.float64]
-        Diversity index for classes and factors
+        :term:`Diversity` index for classes and factors
     classwise : NDArray[np.float64]
         Classwise diversity index [n_class x n_factor]
     """
@@ -34,7 +34,7 @@ def diversity_shannon(
     subset_mask: NDArray[np.bool_] | None = None,
 ) -> NDArray:
     """
-    Compute diversity for discrete/categorical variables and, through standard
+    Compute :term:`diversity<Diversity>` for discrete/categorical variables and, through standard
     histogram binning, for continuous variables.
 
     We define diversity as a normalized form of the Shannon entropy.
@@ -85,7 +85,7 @@ def diversity_simpson(
     subset_mask: NDArray[np.bool_] | None = None,
 ) -> NDArray:
     """
-    Compute diversity for discrete/categorical variables and, through standard
+    Compute :term:`diversity<Diversity>` for discrete/categorical variables and, through standard
     histogram binning, for continuous variables.
 
     We define diversity as the inverse Simpson diversity index linearly rescaled to the unit interval.
@@ -147,8 +147,8 @@ def diversity(
     class_labels: ArrayLike, metadata: Mapping[str, ArrayLike], method: Literal["shannon", "simpson"] = "simpson"
 ) -> DiversityOutput:
     """
-    Compute diversity and classwise diversity for discrete/categorical variables and, through standard
-    histogram binning, for continuous variables.
+    Compute :term:`diversity<Diversity>` and classwise diversity for discrete/categorical variables and,
+    through standard histogram binning, for continuous variables.
 
     We define diversity as a normalized form of the inverse Simpson diversity index.
 

dataeval/_internal/metrics/parity.py

@@ -17,7 +17,7 @@ TData = TypeVar("TData", np.float64, NDArray[np.float64])
 @dataclass(frozen=True)
 class ParityOutput(Generic[TData], OutputMetadata):
     """
-    Output class for :func:`parity` and :func:`label_parity` bias metrics
+    Output class for :func:`parity` and :func:`label_parity` :term:`bias<Bias>` metrics
 
     Attributes
     ----------
@@ -198,7 +198,8 @@ def label_parity(
     num_classes: int | None = None,
 ) -> ParityOutput[np.float64]:
     """
-    Calculate the chi-square statistic to assess the parity between expected and observed label distributions.
+    Calculate the chi-square statistic to assess the :term:`parity<Parity>` between expected and
+    observed label distributions.
 
     This function computes the frequency distribution of classes in both expected and observed labels, normalizes
     the expected distribution to match the total number of observed labels, and then calculates the chi-square
@@ -217,7 +218,7 @@ def label_parity(
     Returns
     -------
     ParityOutput[np.float64]
-        chi-squared score and p-value of the test
+        chi-squared score and :term`P-Value` of the test
 
     Raises
     ------
@@ -231,8 +232,8 @@ def label_parity(
     - Providing ``num_classes`` can be helpful if there are classes with zero instances in one of the distributions.
     - The function first validates the observed distribution and normalizes the expected distribution so that it
       has the same total number of labels as the observed distribution.
-    - It then performs a chi-square test to determine if there is a statistically significant difference between
-      the observed and expected label distributions.
+    - It then performs a :term:`Chi-Square Test of Independence` to determine if there is a statistically significant
+      difference between the observed and expected label distributions.
     - This function acts as an interface to the scipy.stats.chisquare method, which is documented at
       https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.chisquare.html
 
@@ -285,7 +286,8 @@ def parity(
     continuous_factor_bincounts: Mapping[str, int] | None = None,
 ) -> ParityOutput[NDArray[np.float64]]:
     """
-    Calculate chi-square statistics to assess the relationship between multiple factors and class labels.
+    Calculate chi-square statistics to assess the relationship between multiple factors
+    and class labels.
 
     This function computes the chi-square statistic for each metadata factor to determine if there is
     a significant relationship between the factor values and class labels. The function handles both categorical
@@ -308,7 +310,7 @@ def parity(
     -------
     ParityOutput[NDArray[np.float64]]
         Arrays of length (num_factors) whose (i)th element corresponds to the
-        chi-square score and p-value for the relationship between factor i and
+        chi-square score and :term:`p-value<P-Value>` for the relationship between factor i and
         the class labels in the dataset.
 
     Raises

dataeval/_internal/metrics/stats/base.py

@@ -215,7 +215,7 @@ def run_stats(
     stats_processor_cls: Iterable[type[StatsProcessor[TStatsOutput]]],
 ) -> list[TStatsOutput]:
     """
-    Compute specified statistics on a set of images.
+    Compute specified :term:`statistics<Statistics>` on a set of images.
 
     This function applies a set of statistical operations to each image in the input iterable,
     based on the specified output class. The function determines which statistics to apply
@@ -225,7 +225,7 @@ def run_stats(
     ----------
     images : Iterable[ArrayLike]
         An iterable of images (e.g., list of arrays), where each image is represented as an
-        array-like structure (e.g., NumPy arrays).
+        array-like structure (e.g., :term:`NumPy` arrays).
     bboxes : Iterable[ArrayLike]
         An iterable of bounding boxes (e.g. list of arrays) where each bounding box is represented
         as an array-like structure in the format of (X0, Y0, X1, Y1). The length of the bounding boxes
@@ -237,14 +237,16 @@ def run_stats(
 
     Returns
     -------
-    list[TStatsOutput]
-        A list of output classes corresponding to the input processor types.
+    dict[str, NDArray]]
+        A dictionary containing the computed statistics for each image.
+        The dictionary keys correspond to the names of the statistics, and the values are :term:`NumPy` arrays
+        with the results of the computations.
 
     Note
     ----
     - The function performs image normalization (rescaling the image values)
       before applying some of the statistics.
-    - Pixel-level statistics (e.g., brightness, entropy) are computed after
+    - Pixel-level statistics (e.g., :term:`brightness<Brightness>`, entropy) are computed after
       rescaling and, optionally, flattening the images.
     - For statistics like histograms and entropy, intermediate results may
       be reused to avoid redundant computation.

dataeval/_internal/metrics/stats/boxratiostats.py

@@ -98,7 +98,7 @@ def boxratiostats(
     imgstats: TStatOutput,
 ) -> TStatOutput:
     """
-    Calculates ratio statistics of box outputs over image outputs
+    Calculates ratio :term:`statistics<Statistics>` of box outputs over image outputs
 
     Parameters
     ----------

dataeval/_internal/metrics/stats/datasetstats.py

@@ -89,7 +89,7 @@ def datasetstats(
     labels: Iterable[ArrayLike] | None = None,
 ) -> DatasetStatsOutput:
     """
-    Calculates various statistics for each image
+    Calculates various :term:`statistics<Statistics>` for each image
 
     This function computes dimension, pixel and visual metrics
     on the images or individual bounding boxes for each image as

dataeval/_internal/metrics/stats/dimensionstats.py

@@ -31,7 +31,7 @@ class DimensionStatsOutput(BaseStatsOutput):
     size : NDArray[np.uint32]
         Size of the images in pixels
     aspect_ratio : NDArray[np.float16]
-        Aspect ratio of the images (width/height)
+        :term:`ASspect Ratio<Aspect Ratio>` of the images (width/height)
     depth : NDArray[np.uint8]
         Color depth of the images in bits
     center : NDArray[np.uint16]
@@ -77,7 +77,7 @@ def dimensionstats(
     bboxes: Iterable[ArrayLike] | None = None,
 ) -> DimensionStatsOutput:
     """
-    Calculates dimension statistics for each image
+    Calculates dimension :term:`statistics<Statistics>` for each image
 
     This function computes various dimensional metrics (e.g., width, height, channels)
     on the images or individual bounding boxes for each image.
@@ -94,7 +94,7 @@ def dimensionstats(
     DimensionStatsOutput
         A dictionary-like object containing the computed dimension statistics for each image or bounding
         box. The keys correspond to the names of the statistics (e.g., 'width', 'height'), and the values
-        are lists of results for each image or numpy arrays when the results are multi-dimensional.
+        are lists of results for each image or :term:NumPy` arrays when the results are multi-dimensional.
 
     See Also
     --------

dataeval/_internal/metrics/stats/hashstats.py

@@ -20,7 +20,7 @@ class HashStatsOutput(BaseStatsOutput):
     xxhash : List[str]
         xxHash hash of the images as a hex string
     pchash : List[str]
-        Perception hash of the images as a hex string
+        :term:`Perception-based Hash` of the images as a hex string
     """
 
     xxhash: list[str]
@@ -60,11 +60,11 @@ def hashstats(
 
     See Also
     --------
-    Duplicates
+    :term:`Duplicates`
 
     Examples
     --------
-    Calculating the statistics on the images, whose shape is (C, H, W)
+    Calculating the :term:`statistics<Statistics>` on the images, whose shape is (C, H, W)
 
     >>> results = hashstats(images)
     >>> print(results.xxhash)

dataeval/_internal/metrics/stats/labelstats.py

@@ -60,7 +60,7 @@ def labelstats(
     labels: Iterable[ArrayLike],
 ) -> LabelStatsOutput:
     """
-    Calculates statistics for data labels
+    Calculates :term:`statistics<Statistics>` for data labels
 
     This function computes counting metrics (e.g., total per class, total per image)
     on the labels.
@@ -68,7 +68,7 @@ def labelstats(
     Parameters
     ----------
     labels : ArrayLike, shape - [label] | [[label]] or (N,M) | (N,)
-        Lists or numpy array of labels.
+        Lists or :term:`NumPy` array of labels.
         A set of lists where each list contains all labels per image -
         (e.g. [[label1, label2], [label2], [label1, label3]] or [label1, label2, label1, label3]).
         If a numpy array, N is the number of images, M is the number of labels per image.
@@ -80,7 +80,7 @@ def labelstats(
 
     Examples
     --------
-    Calculating the statistics on labels for a set of data
+    Calculating the :term:`statistics<Statistics>` on labels for a set of data
 
     >>> stats = labelstats(labels)
     >>> stats.label_counts_per_class

dataeval/_internal/metrics/stats/pixelstats.py

@@ -23,7 +23,7 @@ class PixelStatsOutput(BaseStatsOutput):
     std : NDArray[np.float16]
         Standard deviation of the pixel values of the images
     var : NDArray[np.float16]
-        Variance of the pixel values of the images
+        :term:`Variance` of the pixel values of the images
     skew : NDArray[np.float16]
         Skew of the pixel values of the images
     kurtosis : NDArray[np.float16]
@@ -73,7 +73,7 @@ def pixelstats(
     per_channel: bool = False,
 ) -> PixelStatsOutput:
     """
-    Calculates pixel statistics for each image
+    Calculates pixel :term:`statistics<Statistics>` for each image
 
     This function computes various statistical metrics (e.g., mean, standard deviation, entropy)
     on the images as a whole.
@@ -90,7 +90,7 @@ def pixelstats(
     PixelStatsOutput
         A dictionary-like object containing the computed statistics for each image. The keys correspond
         to the names of the statistics (e.g., 'mean', 'std'), and the values are lists of results for
-        each image or numpy arrays when the results are multi-dimensional.
+        each image or :term:`NumPy` arrays when the results are multi-dimensional.
 
     See Also
     --------

dataeval/_internal/metrics/stats/visualstats.py

@@ -82,7 +82,7 @@ def visualstats(
     """
     Calculates visual statistics for each image
 
-    This function computes various visual metrics (e.g., brightness, darkness, contrast, sharpness)
+    This function computes various visual metrics (e.g., :term:`brightness<Brightness>`, darkness, contrast, blurriness)
     on the images as a whole.
 
     Parameters
@@ -96,8 +96,8 @@ def visualstats(
     -------
     VisualStatsOutput
         A dictionary-like object containing the computed visual statistics for each image. The keys correspond
-        to the names of the statistics (e.g., 'brightness', 'sharpness'), and the values are lists of results for
-        each image or numpy arrays when the results are multi-dimensional.
+        to the names of the statistics (e.g., 'brightness', 'blurriness'), and the values are lists of results for
+        each image or :term:`NumPy` arrays when the results are multi-dimensional.
 
     See Also
     --------
@@ -109,7 +109,7 @@ def visualstats(
 
     Examples
     --------
-    Calculating the statistics on the images, whose shape is (C, H, W)
+    Calculating the :term:`statistics<Statistics>` on the images, whose shape is (C, H, W)
 
     >>> results = visualstats(images)
     >>> print(results.brightness)

dataeval/_internal/metrics/uap.py

@@ -1,7 +1,7 @@
 """
 This module contains the implementation of the
-FR Test Statistic based estimate for the upperbound
-average precision using empirical mean precision
+FR Test Statistic based estimate for the :term:`upper-bound
+average precision<Upper-Bound Average Precision (UAP)>` using empirical mean precision
 """
 
 from __future__ import annotations
@@ -38,7 +38,7 @@ def uap(labels: ArrayLike, scores: ArrayLike) -> UAPOutput:
     Parameters
     ----------
     labels : ArrayLike
-        A numpy array of n_samples of class labels with M unique classes.
+        A term:`NumPy` array of n_samples of class labels with M unique classes.
     scores : ArrayLike
         A 2D array of class probabilities per image
 

dataeval/_internal/metrics/utils.py

@@ -78,8 +78,8 @@ def entropy(
     subset_mask: NDArray[np.bool_] | None = None,
 ) -> NDArray[np.float64]:
     """
-    Meant for use with Bias metrics, Balance, Diversity, ClasswiseBalance,
-    and Classwise Diversity.
+    Meant for use with :term:`bias<Bias>` metrics, :term:`balance<Balance>`, :term:`diversity<Diversity>`,
+    ClasswiseBalance, and Classwise Diversity.
 
     Compute entropy for discrete/categorical variables and for continuous variables through standard
     histogram binning.
@@ -128,7 +128,7 @@ def get_num_bins(
 ) -> NDArray[np.float64]:
     """
     Number of bins or unique values for each metadata factor, used to
-    normalize entropy/diversity.
+    normalize entropy/:term:`diversity<Diversity>`.
 
     Parameters
     ----------
@@ -207,12 +207,12 @@ def flatten(X: NDArray):
 
 def minimum_spanning_tree(X: NDArray) -> Any:
     """
-    Returns the minimum spanning tree from a NumPy image array.
+    Returns the minimum spanning tree from a :term:`NumPy` image array.
 
     Parameters
     ----------
     X : NDArray
-        Numpy image array
+        NumPy image array
 
     Returns
     -------
@@ -234,7 +234,7 @@ def get_classes_counts(labels: NDArray) -> tuple[int, int]:
     Parameters
     ----------
     label : NDArray
-        Numpy labels array
+        :term:`NumPy` labels array
 
     Returns
     -------
@@ -389,7 +389,7 @@ def pchash(image: NDArray) -> str:
     Parameters
     ----------
     image : NDArray
-        An image as a numpy array in CxHxW format
+        An image as a :term:`NumPy` array in CxHxW format
 
     Returns
     -------
@@ -437,7 +437,7 @@ def xxhash(image: NDArray) -> str:
     Parameters
     ----------
     image : NDArray
-        An image as a numpy array
+        An image as a :term:NumPy` array
 
     Returns
     -------

dataeval/_internal/models/pytorch/autoencoder.py

@@ -17,7 +17,7 @@ def get_images_from_batch(batch: Any) -> Any:
 
 class AETrainer:
     """
-    A class to train and evaluate an autoencoder model.
+    A class to train and evaluate an autoencoder<Autoencoder>` model.
 
     Parameters
     ----------
@@ -44,7 +44,7 @@ class AETrainer:
 
     def train(self, dataset: Dataset, epochs: int = 25) -> list[float]:
         """
-        Basic image reconstruction training function for Autoencoder models
+        Basic image reconstruction training function for :term:`Autoencoder` models
 
         Uses `torch.optim.Adam` and `torch.nn.MSELoss` as default hyperparameters
 
@@ -59,7 +59,7 @@ class AETrainer:
         Returns
         -------
         List[float]
-            A list of average loss values for each epoch.
+            A list of average loss values for each :term:`epoch<Epoch>`.
 
         Note
         ----
@@ -103,7 +103,7 @@ class AETrainer:
     @torch.no_grad
     def eval(self, dataset: Dataset) -> float:
         """
-        Basic image reconstruction evaluation function for Autoencoder models
+        Basic image reconstruction evaluation function for :term:`autoencoder<Autoencoder>` models
 
         Uses `torch.nn.MSELoss` as default loss function.
 
@@ -139,7 +139,7 @@ class AETrainer:
     @torch.no_grad
     def encode(self, dataset: Dataset) -> torch.Tensor:
         """
-        Create image embeddings for the dataset using the model's encoder.
+        Create image :term:`embeddings<Embeddings>` for the dataset using the model's encoder.
 
         If the model has an `encode` method, it will be used; otherwise,
         `model.forward` will be used.
@@ -178,7 +178,7 @@ class AETrainer:
 
 class AriaAutoencoder(nn.Module):
     """
-    An autoencoder model with a separate encoder and decoder.
+    An :term:`autoencoder<Autoencoder>` model with a separate encoder and decoder.
 
     Parameters
     ----------
@@ -228,7 +228,7 @@ class AriaAutoencoder(nn.Module):
 
 class Encoder(nn.Module):
     """
-    A simple encoder to be used in an autoencoder model.
+    A simple encoder to be used in an :term:`autoencoder<Autoencoder>` model.
 
     This is the encoder used by the AriaAutoencoder model.
 
@@ -269,7 +269,7 @@ class Encoder(nn.Module):
 
 class Decoder(nn.Module):
     """
-    A simple decoder to be used in an autoencoder model.
+    A simple decoder to be used in an :term:`autoencoder<Autoencoder>` model.
 
     This is the decoder used by the AriaAutoencoder model.
 

dataeval/_internal/models/pytorch/utils.py

@@ -17,7 +17,7 @@ def torch_to_numpy(tensor: Tensor) -> ndarray:
 
 def numpy_to_torch(array: ndarray) -> Tensor:
     """
-    Converts a NumPy array to a PyTorch tensor
+    Converts a :term:`NumPy` array to a PyTorch tensor
     """
     if isinstance(array, Tensor):  # Already tensor, return
         return array
@@ -29,7 +29,7 @@ def numpy_to_torch(array: ndarray) -> Tensor:
 
 def permute_to_torch(array: ndarray) -> Tensor:
     """
-    Converts and permutes a NumPy image array into a PyTorch image tensor.
+    Converts and permutes a :term:`NumPy` image array into a PyTorch image tensor.
 
     Parameters
     ----------
@@ -48,7 +48,7 @@ def permute_to_torch(array: ndarray) -> Tensor:
 
 def permute_to_numpy(tensor: Tensor) -> ndarray:
     """
-    Converts and permutes a PyTorch image tensor into a NumPy image array.
+    Converts and permutes a PyTorch image tensor into a :term:`NumPy` image array.
 
     Does not permute if given ndarray
 

dataeval/_internal/models/tensorflow/autoencoder.py

@@ -90,7 +90,7 @@ class Sampling(Layer):
         Parameters
         ----------
         inputs
-            Tuple with mean and log variance.
+            Tuple with mean and log :term:`variance<Variance>`.
 
         Returns
         -------
@@ -131,7 +131,7 @@ class EncoderVAE(Layer):
         encoder_net
             Layers for the encoder wrapped in a keras.Sequential class.
         latent_dim
-            Dimensionality of the latent space.
+            Dimensionality of the :term:`latent space<Latent Space>`.
         name
             Name of encoder.
         """
@@ -204,7 +204,7 @@ class VAE(keras.Model):
     decoder_net : keras.Model
         Layers for the decoder wrapped in a keras.Sequential class.
     latent_dim : int
-        Dimensionality of the latent space.
+        Dimensionality of the :term:`latent space<Latent Space>`.
     beta : float, default 1.0
         Beta parameter for KL-divergence loss term.
     """
@@ -282,7 +282,7 @@ class VAEGMM(keras.Model):
     n_gmm : int
         Number of components in GMM.
     latent_dim : int
-        Dimensionality of the latent space.
+        Dimensionality of the :term:`latent space<Latent Space>`.
     recon_features : Callable, default eucl_cosim_features
         Function to extract features from the reconstructed instance by the decoder.
     beta : float, default 1.0

dataeval/_internal/models/tensorflow/losses.py

@@ -31,7 +31,7 @@ class Elbo:
     Parameters
     ----------
     cov_type : Union[Literal["cov_full", "cov_diag"], float], default 1.0
-        Full covariance matrix, diagonal variance matrix, or scale identity multiplier.
+        Full covariance matrix, diagonal :term:`variance<Variance>` matrix, or scale identity multiplier.
     x : ArrayLike, optional - default None
         Dataset used to calculate the covariance matrix.  Required for full and diagonal covariance matrix types.
     """

dataeval/_internal/models/tensorflow/pixelcnn.py

@@ -400,7 +400,7 @@ class PixelCNN(distribution.Distribution):
         Parameters
         ----------
         value
-            `Tensor` or Numpy array of image data. May have leading batch
+            `Tensor` or :term:`NumPy` array of image data. May have leading batch
             dimension(s), which must broadcast to the leading batch dimensions of
             `conditional_input`.
         conditional_input
@@ -706,7 +706,7 @@ class _PixelCNNNetwork(keras.layers.Layer):
         use_data_init: bool = True,
         dtype=tf.float32,
     ) -> None:
-        """Initialize the neural network for the Pixel CNN++ distribution.
+        """Initialize the :term:`neural network<Neural Network>` for the Pixel CNN++ distribution.
 
         Parameters
         ----------

dataeval/_internal/models/tensorflow/utils.py

@@ -55,7 +55,7 @@ def predict_batch(
 
     Returns
     -------
-    Numpy array, tensorflow tensor or tuples of those with model outputs.
+    :term:`NumPy` array, tensorflow tensor or tuples of those with model outputs.
     """
     n = len(x)
     n_minibatch = int(np.ceil(n / batch_size))