Skip to content
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

Jump to bottom

Issue #1855 Correct docstrings in TimeSeries methods #1856

Merged
merged 1 commit into from
Jun 28, 2023
Merged

Issue #1855 Correct docstrings in TimeSeries methods #1856

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
10 changes: 5 additions & 5 deletions darts/timeseries.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3942,7 +3942,7 @@ def mean(self, axis: int = 2) -> Self:
"""
Return a ``TimeSeries`` containing the mean calculated over the specified axis.

If we reduce over time (``axis=1``), the resulting ``TimeSeries`` will have length one and will use the first
If we reduce over time (``axis=0``), the resulting ``TimeSeries`` will have length one and will use the first
entry of the original ``time_index``. If we perform the calculation over the components (``axis=1``), the
resulting single component will be renamed to "components_mean". When applied to the samples (``axis=2``),
a deterministic ``TimeSeries`` is returned.
Expand Down Expand Up @@ -3975,7 +3975,7 @@ def median(self, axis: int = 2) -> Self:
"""
Return a ``TimeSeries`` containing the median calculated over the specified axis.

If we reduce over time (``axis=1``), the resulting ``TimeSeries`` will have length one and will use the first
If we reduce over time (``axis=0``), the resulting ``TimeSeries`` will have length one and will use the first
entry of the original ``time_index``. If we perform the calculation over the components (``axis=1``), the
resulting single component will be renamed to "components_median". When applied to the samples (``axis=2``),
a deterministic ``TimeSeries`` is returned.
Expand Down Expand Up @@ -4009,7 +4009,7 @@ def sum(self, axis: int = 2) -> Self:
"""
Return a ``TimeSeries`` containing the sum calculated over the specified axis.

If we reduce over time (``axis=1``), the resulting ``TimeSeries`` will have length one and will use the first
If we reduce over time (``axis=0``), the resulting ``TimeSeries`` will have length one and will use the first
entry of the original ``time_index``. If we perform the calculation over the components (``axis=1``), the
resulting single component will be renamed to "components_sum". When applied to the samples (``axis=2``),
a deterministic ``TimeSeries`` is returned.
Expand Down Expand Up @@ -4042,7 +4042,7 @@ def min(self, axis: int = 2) -> Self:
"""
Return a ``TimeSeries`` containing the min calculated over the specified axis.

If we reduce over time (``axis=1``), the resulting ``TimeSeries`` will have length one and will use the first
If we reduce over time (``axis=0``), the resulting ``TimeSeries`` will have length one and will use the first
entry of the original ``time_index``. If we perform the calculation over the components (``axis=1``), the
resulting single component will be renamed to "components_min". When applied to the samples (``axis=2``),
a deterministic ``TimeSeries`` is returned.
Expand Down Expand Up @@ -4075,7 +4075,7 @@ def max(self, axis: int = 2) -> Self:
"""
Return a ``TimeSeries`` containing the max calculated over the specified axis.

If we reduce over time (``axis=1``), the resulting ``TimeSeries`` will have length one and will use the first
If we reduce over time (``axis=0``), the resulting ``TimeSeries`` will have length one and will use the first
entry of the original ``time_index``. If we perform the calculation over the components (``axis=1``), the
resulting single component will be renamed to "components_max". When applied to the samples (``axis=2``),
a deterministic ``TimeSeries`` is returned.
Expand Down