Skip to content

Commit

Permalink
Update documentation links and add hints in plot.py
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilipMay committed Dec 21, 2023
1 parent e8f6709 commit 3a136d6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
3 changes: 2 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,11 @@
# "transformers": ("https://huggingface.co/transformers/", None),
"optuna": ("https://optuna.readthedocs.io/en/stable/", None),
"mlflow": ("https://www.mlflow.org/docs/latest/", None),
"scipy": ("https://docs.scipy.org/doc/scipy/reference/", None),
"scipy": ("https://docs.scipy.org/doc/scipy/", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"git": ("https://gitpython.readthedocs.io/en/stable/", None),
"platformdirs": ("https://platformdirs.readthedocs.io/en/latest/", None),
#"matplotlib": ("https://matplotlib.org/stable/", None),
}

# html_logo = "imgs/xxx.png"
Expand Down
12 changes: 8 additions & 4 deletions mltb2/plot.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ def twin_axes_timeseries_plot(
"""Create twin axes timeseries plot.
Plots two different timeseries curves in one diagram but two different y-axes.
This function does not call `matplotlib.pyplot.plot()`.
Hint:
This function does not use `matplotlib.pyplot.plot`.
Args:
values_1: (``array_like``) Values for the first timeseries curve.
Expand Down Expand Up @@ -90,7 +92,8 @@ def boxplot(
):
"""Prints one or more boxplots in a single diagram.
This function does not call `matplotlib.pyplot.plot()`.
Hint:
This function does not use `matplotlib.pyplot.plot`.
Args:
values: Values for the boxplot(s).
Expand Down Expand Up @@ -133,7 +136,8 @@ def boxplot_dict(
):
"""Create boxplot form dictionary.
This function does not call `matplotlib.pyplot.plot()`.
Hint:
This function does not use `matplotlib.pyplot.plot`.
Args:
values_dict: Dictionary with values for the boxplot(s).
Expand All @@ -154,7 +158,7 @@ def boxplot_dict(


def save_last_figure(filename):
"""Saves the last plot.
"""Saves the last plot made by Matplotlib.
For jupyter notebooks this has to be called in the same cell that created the plot.
"""
Expand Down

0 comments on commit 3a136d6

Please sign in to comment.