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

Stream unspecified docstring change #377

Merged

Conversation

snarayan21
Copy link
Collaborator

Description of changes:

docstring change detailing unspecified and epoch_size behavior for streams.

Issue #, if available:

Merge Checklist:

Put an x without space in the boxes that apply. If you are unsure about any checklist, please don't hesitate to ask. We are here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

  • I have read the contributor guidelines
  • This is a documentation change or typo fix. If so, skip the rest of this checklist.
  • I certify that the changes I am introducing will be backward compatible, and I have discussed concerns about this, if any, with the MosaicML team.
  • I have updated any necessary documentation, including README and API docs (if appropriate).

Tests

  • I ran pre-commit on my change. (check out the pre-commit section of prerequisites)
  • I have added tests that prove my fix is effective or that my feature works (if appropriate).
  • I ran the tests locally to make sure it pass. (check out testing)
  • I have added unit and/or integration tests as appropriate to ensure backward compatibility of the changes.

@snarayan21 snarayan21 enabled auto-merge (squash) August 11, 2023 01:18
* At most one of ``proportion``, ``repeat``, or ``choose`` may exist. If provided one of these,
we derive the others. Note that ``proportion`` (relative) and ``repeat``/``choose`` (absolute)
are mutually incompatible -- you must entirely use one or the other (or neither) for all
sub-datasets.If none are provided for all streams and epoch_size is unspecified, then each
Copy link
Contributor

Choose a reason for hiding this comment

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

Space after .

Double ticks around epoch size

@snarayan21 snarayan21 merged commit 76f71ce into mosaicml:main Aug 11, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants