Make `dataset.ishuffle` optional

[krajsek]

Due Diligence

• General:
  • [x] title of the PR is suitable to appear in the release notes
• Implementation:
  • [x] unit tests: no unit test added, so far datatools.py has no unit tests
  • [x] unit tests: no, same as above
  • [x] documentation updated where needed

Description

So far, the Heat dataset requires the implementation of an ishuffle method that defines the shuffling of data between epochs. This is not compatible with the PyTorch dataset class. To enable the use of PyTorch dataset classes, ishuffle is now optional.

Type of change

• New feature

Does this change modify the behaviour of other functions? If so, which?

no

[github-actions[bot]]

Thank you for the PR!

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.80%. Comparing base (586788e) to head (c27e822). Report is 5 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #1529 +/- ## ======================================= Coverage 91.80% 91.80% ======================================= Files 80 80 Lines 11772 11773 +1 ======================================= + Hits 10807 10808 +1 Misses 965 965 ``` | [Flag](https://app.codecov.io/gh/helmholtz-analytics/heat/pull/1529/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=helmholtz-analytics) | Coverage Δ | | |---|---|---| | [unit](https://app.codecov.io/gh/helmholtz-analytics/heat/pull/1529/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=helmholtz-analytics) | `91.80% <100.00%> (+<0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=helmholtz-analytics#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[github-actions[bot]]

Thank you for the PR!