For all changes in this release see: https://github.com/mad-lab-fau/tpcp/pull/85
Deprecated
- The properties `group` and `groups` of the `Dataset` class are deprecated and will be removed in a future
release.
They are replaced by the `group_label` and `group_labels` properties of the `Dataset` class.
This renaming was done to make it more clear that these properties return the labels of the groups and not the
groups themselves.
- The `create_group_labels` method of the `Dataset` class is deprecated and will be removed in a future release.
It is replaced by the `create_string_group_labels` method of the `Dataset` class.
This renaming was done to avoid confusion with the new names for `groups` and `group`
Added
- Added `index_as_tuples` method to the `Dataset` class.
It returns the full index of the dataset as a list of named tuples regardless of the current grouping.
This might be helpful to extract the label information of a datapoint, when `group` requires to handle multiple cases,
as your code expects the dataset in different grouped versions.
Changed
- **BREAKING CHANGE (with Deprecation)**: The `group` property of the `Dataset` class is now called `group_label`.
- **BREAKING CHANGE**: The `group_label` property now always returns named tuples of strings
(even for single groups where it used to return strings!).
- **BREAKING CHANGE (with Deprecation)**: The `groups` property of the `Dataset` class is now called `group_labels`.
- **BREAKING CHANGE**: The `group_labels` property always returns a list of named tuples of strings
(even for single groups where it used to return a list of strings!).
- **BREAKING CHANGE**: The parameter `groups` of the `get_subset` method of the `Dataset` class is now called
`group_labels` and always expects a list of named tuples of strings.