Skip to content

Commit

Permalink
Add more explicit docs about resolution strings
Browse files Browse the repository at this point in the history
  • Loading branch information
milesgranger authored and epa095 committed Sep 23, 2019
1 parent 7327f7d commit f2461a9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 10 deletions.
16 changes: 6 additions & 10 deletions gordo_components/dataset/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,25 +37,21 @@ def join_timeseries(
Parameters
----------
series_iterable
series_iterable: Iterable[pd.Series]
An iterator supplying series with time index
resampling_startpoint
resampling_startpoint: datetime.datetime
The starting point for resampling. Most data frames will not have this
in their datetime index, and it will be inserted with a NaN as the value.
The resulting NaNs will be removed, so the only important requirement for this is
that this resampling_startpoint datetime must be before or equal to the first
(earliest) datetime in the data to be resampled.
resampling_endpoint
resampling_endpoint: datetime.datetime
The end point for resampling. This datetime must be equal to or after the last datetime in the
data to be resampled.
resolution
resolution: str
The bucket size for grouping all incoming time data (e.g. "10T")
aggregation_methods
Available strings come from https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#dateoffset-objects
aggregation_methods: Union[str, List[str], Callable]
Aggregation method(s) to use for the resampled buckets. If a single
resample method is provided then the resulting dataframe will have names
identical to the names of the series it got in. If several
Expand Down
1 change: 1 addition & 0 deletions gordo_components/dataset/datasets.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ def __init__(
into the y return from ``.get_data()``
resolution: str
The bucket size for grouping all incoming time data (e.g. "10T").
Available strings come from https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#dateoffset-objects
row_filter: str
Filter on the rows. Only rows satisfying the filter will be in the dataset.
See :func:`gordo_components.dataset.filter_rows.pandas_filter_rows` for
Expand Down

0 comments on commit f2461a9

Please sign in to comment.