Skip to content

[DOC] Added Missing Docstring for Plot Pairwise Distance Matrix #2609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MatthewMiddlehurst merged 1 commit into from
Apr 3, 2025
Merged

[DOC] Added Missing Docstring for Plot Pairwise Distance Matrix #2609

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion aeon/visualisation/distances/_pairwise_distance_matrix.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,24 @@ def plot_pairwise_distance_matrix(
b,
path,
):

"""Plot a pairwise distance matrix between two time series.

Parameters
----------
distance_matrix : np.ndarray
The pairwise distance matrix to plot.
a : np.ndarray
The first time series.
b : np.ndarray
The second time series.
path : list of tuple
The path of the minimum distances.

Returns
-------
ax : matplotlib.axes.Axes
The Axes object with the plot.
"""
# Checks availability of plotting libraries
_check_soft_dependencies("matplotlib", "seaborn")
import matplotlib.pyplot as plt
Expand Down