Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update gluonts.dataset.split code, test, docs #2223

Merged
merged 2 commits into from
Aug 22, 2022

Conversation

lostella
Copy link
Contributor

@lostella lostella commented Aug 19, 2022

Description of changes: Follow up to #2031, #2157 with further adjustments:

  • Rename TestIterable into TestDataset
  • Add input and label properties to TestDataset
  • Rename split_date and split_offset, in DateSplitter and OffsetSplitter, to date and offset respectively
  • Update the module docstring and make it a (running) doctest
  • Remove subpackage in favor of the module directly
  • Add/fix type annotations where needed
  • Change tests and documentation notebooks accordingly

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Please tag this pr with at least one of these labels to make our release process faster: BREAKING, new feature, bug fix, other change, dev setup

@lostella lostella added the pr:docs-build-notebook Build notebooks for pull-request. label Aug 19, 2022
@lostella lostella added the BREAKING This is a breaking change (one of pr required labels) label Aug 19, 2022
@lostella lostella requested a review from jaheba August 19, 2022 12:32
@lostella lostella marked this pull request as ready for review August 19, 2022 12:32
@@ -15,36 +15,65 @@
Train/test splitter
~~~~~~~~~~~~~~~~~~~

.. testsetup:: *
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's to add doctest snippets that run, but are not displayed, see: https://www.sphinx-doc.org/en/master/usage/extensions/doctest.html#directive-testsetup

For example for imports or some other setup that is used by following doctest snippets.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BREAKING This is a breaking change (one of pr required labels) pr:docs-build-notebook Build notebooks for pull-request.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants