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

Add a readme for text and vision convert script modal type #183

Merged
merged 7 commits into from
Mar 3, 2023

Conversation

karan6181
Copy link
Collaborator

Description of changes:

  • Add a readme for NLP and CV convert script modal type.
  • Update the conversion scripts with method comments.

Issue #, if available:

CO-1677

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.

Copy link
Collaborator

@bandish-shah bandish-shah left a comment

Choose a reason for hiding this comment

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

Made some minor grammatical and wording nits. Will leave it up to @knighton to sign off on functionality.

streaming/text/convert/README.md Outdated Show resolved Hide resolved
streaming/text/convert/README.md Outdated Show resolved Hide resolved
streaming/text/convert/README.md Outdated Show resolved Hide resolved
streaming/text/convert/README.md Outdated Show resolved Hide resolved
streaming/text/convert/README.md Outdated Show resolved Hide resolved
streaming/vision/convert/README.md Outdated Show resolved Hide resolved
streaming/vision/convert/README.md Outdated Show resolved Hide resolved
streaming/vision/convert/README.md Outdated Show resolved Hide resolved
streaming/vision/convert/README.md Outdated Show resolved Hide resolved
streaming/vision/convert/README.md Outdated Show resolved Hide resolved
@bandish-shah
Copy link
Collaborator

Would it also be possible to link to the README's on the docs site? My impression is that these examples are nested in the streaming package and it's not obvious where to find them without digging. We may want to eventually consider up-leveling the conversion scripts in the repo, it doesn't really make sense to have these scripts in the package unless users can invoke them through the streaming API for conversion.

karan6181 and others added 2 commits March 3, 2023 12:45
Co-authored-by: bandish-shah <86627118+bandish-shah@users.noreply.github.com>
streaming/text/convert/README.md Outdated Show resolved Hide resolved
streaming/text/convert/README.md Outdated Show resolved Hide resolved
@karan6181
Copy link
Collaborator Author

Would it also be possible to link to the README's on the docs site? My impression is that these examples are nested in the streaming package and it's not obvious where to find them without digging. We may want to eventually consider up-leveling the conversion scripts in the repo, it doesn't really make sense to have these scripts in the package unless users can invoke them through the streaming API for conversion.

Yes, valid point. I have added a short and concise doc dataset_conversion_to_mds.md that references the readme.

Copy link
Collaborator

@bandish-shah bandish-shah left a comment

Choose a reason for hiding this comment

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

👍

@karan6181 karan6181 merged commit ed90487 into mosaicml:main Mar 3, 2023
@karan6181 karan6181 deleted the convert_script_doc branch March 3, 2023 23:55
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.

3 participants