Skip to content

Commit

Permalink
docs: fixed docs (#916)
Browse files Browse the repository at this point in the history
Closes #XYZ

### Summary of Changes

<!-- Please provide a summary of changes in this pull request, ensuring
all changes are explained. -->
changed some docs in time series dataset and moving average plot.

---------

Co-authored-by: Alexander <[email protected]>
  • Loading branch information
Gerhardsa0 and Marsmaennchen221 committed Jul 16, 2024
1 parent 5b5bb3f commit ee1aea0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
13 changes: 8 additions & 5 deletions src/safeds/data/labeled/containers/_time_series_dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@

class TimeSeriesDataset(Dataset[Table, Column]):
"""
A time series dataset maps feature and time columns to a target column.
A time series dataset maps feature to a target column. It can be used to train machine learning models.
Data can be segmented into windows when loading it into the models.
Unlike a TabularDataset, a TimeSeries needs to contain one target and one time column, but can have empty features.
Parameters
----------
Expand All @@ -37,6 +38,8 @@ class TimeSeriesDataset(Dataset[Table, Column]):
the target column are used as features.
forecast_horizon:
The number of time steps to predict into the future.
continuous
Whether or not to continue the forecast in the steps before forecast horizon.
Raises
------
Expand Down Expand Up @@ -183,7 +186,7 @@ def continuous(self) -> bool:
@property
def extras(self) -> Table:
"""
Additional columns of the time series dataset that are neither features, target nor time.
Additional columns of the time series dataset that are neither features nor target.
These can be used to store additional information about instances, such as IDs.
"""
Expand All @@ -195,14 +198,14 @@ def extras(self) -> Table:

def to_table(self) -> Table:
"""
Return a new `Table` containing the feature columns, the target column, the time column and the extra columns.
Return a new `Table` containing the feature columns, the target column and the extra columns.
The original `TimeSeriesDataset` is not modified.
Returns
-------
table:
A table containing the feature columns, the target column, the time column and the extra columns.
A table containing the feature columns, the target column and the extra columns.
"""
return self._table

Expand Down
2 changes: 2 additions & 0 deletions src/safeds/data/tabular/plotting/_table_plotter.py
Original file line number Diff line number Diff line change
Expand Up @@ -504,6 +504,8 @@ def moving_average_plot(
The name of the column to be plotted on the x-axis.
y_name:
The name of the column to be plotted on the y-axis.
window_size:
The size of the moving average window
theme:
The color theme of the plot. Default is "light".
Expand Down

0 comments on commit ee1aea0

Please sign in to comment.