TimeSeries
Bases: BaseSynthesizer
Source code in ydata/sdk/synthesizers/timeseries.py
fit(X, sortbykey, entity_id_cols=None, generate_cols=None, exclude_cols=None, dtypes=None, target=None, name=None)
Fit the synthesizer.
The synthesizer accepts as training dataset either a pandas DataFrame
directly or a YData DataSource
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
X |
Union[DataSource, pandas.DataFrame]
|
Training dataset |
required |
sortbykey |
Union[str, List[str]]
|
column(s) to use to sort timeseries datasets |
required |
entity_id_cols |
Union[str, List[str]]
|
(optional) columns representing entities ID |
None
|
generate_cols |
List[str]
|
(optional) columns that should be synthesized |
None
|
exclude_cols |
List[str]
|
(optional) columns that should not be synthesized |
None
|
dtypes |
Dict[str, Union[str, DataType]]
|
(optional) datatype mapping that will overwrite the datasource metadata column datatypes |
None
|
target |
Optional[str]
|
(optional) Metadata associated to the datasource |
None
|
name |
Optional[str]
|
(optional) Synthesizer instance name |
None
|
Source code in ydata/sdk/synthesizers/timeseries.py
sample(n_entities=None)
Sample from a [TimeSeriesSynthesizer
][ydata.sdk.synthesizers.TimeS
eriesSynthesizer] instance.
If a training dataset was not using any entity
column, the Synthesizer assumes a single entity.
A TimeSeriesSynthesizer
always sample the full trajectory of its entities.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
n_entities |
int
|
(optional) number of entities to sample. If |
None
|
Returns:
Type | Description |
---|---|
pdDataFrame
|
synthetic data |