tempor.datasources.treatments.one_off.plugin_pkpd module¶

Module for the PKPD data source plugin.

class tempor.datasources.treatments.one_off.plugin_pkpd.PKPDDataSource(n_timesteps: int = 10, time_index_treatment_event: int = 7, n_control_samples: int = 20, n_treated_samples: int = 20, random_state: int = 100, **kwargs: Any)[source]¶

Bases: OneOffTreatmentEffectsDataSource

PKPD data source for one-off treatment effects tasks.

Adapted from: https://github.com/ZhaozhiQIAN/SyncTwin-NeurIPS-2021

Parameters:¶

n_timesteps : int, optional¶

Number of timesteps. Defaults to 10.

time_index_treatment_event : int, optional¶

Time index of the treatment event. Defaults to 7.

n_control_samples : int, optional¶

Number of control samples to generate. Defaults to 20.

n_treated_samples : int, optional¶

Number of treated samples to generate. Defaults to 20.

random_state : int, optional¶

Random state to use. Defaults to 100.

**kwargs : Any

Any additional keyword arguments will be passed to parent constructor.

Reference:

Qian, Z., Zhang, Y., Bica, I., Wood, A., & van der Schaar, M. (2021). Synctwin: Treatment effect estimation with longitudinal outcomes. Advances in Neural Information Processing Systems, 34, 3178-3190.

static url() → None[source]¶

Define the URL of the data source, if relevant, otherwise return None.

Returns:¶

The URL of the data source, if relevant, otherwise None.

Return type:¶

Optional[str]

static dataset_dir() → None[source]¶

The path to the directory where the data file(s) will be stored, if relevant. If the data source has no data files, return None.

Note

the path should correspond to a subdirectory within data_root_dir.

Returns:¶

The path of the directory where the data file(s) will be stored, if relevant, else None.

Return type:¶

Optional[str]

load(**kwargs: Any) → OneOffTreatmentEffectsDataset[source]¶

The method that should return a one-off treatment effects dataset.

Parameters:¶

**kwargs : Any

Any additional keyword arguments.

Returns:¶

The loaded dataset.

Return type:¶

dataset.OneOffTreatmentEffectsDataset

category : ClassVar[plugin_typing.PluginCategory] = 'treatments.one_off'¶

Plugin category, such as 'prediction.one_off.classification'. Must be set by the plugin class using @register_plugin.

name : ClassVar[plugin_typing.PluginName] = 'pkpd'¶

Plugin name, such as 'my_nn_classifier'. Must be set by the plugin class using @register_plugin.

plugin_type : ClassVar[plugin_typing.PluginTypeArg] = 'datasource'¶

Plugin type, such as 'method'. May be optionally set by the plugin class using @register_plugin, else will set the default plugin type.