Skip to content

Commit

Permalink
Fix for documentation warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
dimtsap committed Apr 7, 2022
1 parent 62dcf70 commit 2e285ac
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/source/utilities/distances/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Distances
A collection of distance measures between points in the Euclidean space and between subspaces on the Grassmann manifold.

Each distance function in :py:mod:`UQpy` is defined as a subclass of the :class:`.Distance` class. The
:class:`.Distance` class has two further subclasses for Euclidean distances (:class:`.EuclideanDistance`) and
:class:`.Distance` class has two further subclasses for Euclidean distances (:class:`.baseclass.EuclideanDistance,`) and
Grassmann distances (:class:`.GrassmannianDistance`). Individual dsitances, depending on their type, are defined as
subclasses of these.

Expand Down
6 changes: 3 additions & 3 deletions docs/source/utilities/kernels/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ A real-valued positive definite kernel is defined as a symmetric function
where :math:`\sum^n_{i,j=1}c_i c_j k(x_i,x_j) \leq 0` for :math:`n \in \mathbb{N}`, :math:`x_i \in \mathcal{X}`
and :math:`c_i \in \mathbb{R}`.

Each kernel function in :py:mod:`UQpy` is defined as a subclass of the :class:`.Kernel` class. The :class:`.Kernel` has
two further subclasses for Euclidean kernels (:class:`.EuclideanKernel`) and Grassmannian kernels
Each kernel function in :py:mod:`UQpy` is defined as a subclass of the :class:`UQpy.utilities.kernels.baseclass.Kernel`
class. The :class:`UQpy.utilities.kernels.baseclass.Kernel` has two further subclasses for Euclidean kernels (:class:`.EuclideanKernel`) and Grassmannian kernels
(:class:`.GrassmannianKernel`). Individual kernels, depending on their type, are defined as subclasses of these.

Kernel Class
Expand All @@ -25,7 +25,7 @@ The :class:`UQpy.utilities.kernels.baseclass.Kernel` class is imported using the
Types of Kernels
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The :class:`Kernel` class has subclasses for the following types of kernels:
The :class:`UQpy.utilities.kernels.baseclass.Kernel` class has subclasses for the following types of kernels:

.. toctree::
:maxdepth: 1
Expand Down
2 changes: 1 addition & 1 deletion src/UQpy/utilities/kernels/baseclass/EuclideanKernel.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ def __init__(self):

def calculate_kernel_matrix(self, points: Numpy2DFloatArray):
"""
Using the kernel-specific :py:meth:`.kernel_entry` method, this function assembles the kernel matrix.
Using the kernel-specific :py:meth:`.Kernel.kernel_entry` method, this function assembles the kernel matrix.
:param points: Set of data points in the Euclidean space
Expand Down

0 comments on commit 2e285ac

Please sign in to comment.