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

Trying to add a new page under Data types and IO section for tensorfl… #5807

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

sumana-2705
Copy link

Tracking issue

Closes #4065

Why are the changes needed?

  • User Understanding: Enhances clarity on how to use TensorFlow types within Flyte.
  • Integration Guidance: Provides step-by-step instructions for integrating TensorFlow models and datasets.
  • Error Reduction: Helps users avoid common pitfalls and integration errors.
  • Improved Documentation: Fills a gap in the existing documentation for better usability.
  • Increased Efficiency: Streamlines the workflow for users working with TensorFlow in Flyte.

What changes were proposed in this pull request?

This PR introduces a new page in the Data Types and IO section of the user guide, documenting all available TensorFlow types in Flyte. It includes detailed explanations of the TensorFlowModel, TFRecordFile, and TFRecordsDirectory, along with the TFRecordDatasetConfig configuration class.

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All commits are signed-off.

Docs link

Data Types and IO

Copy link

welcome bot commented Oct 4, 2024

Thank you for opening this pull request! 🙌

These tips will help get your PR across the finish line:

  • Most of the repos have a PR template; if not, fill it out to the best of your knowledge.
  • Sign off your commits (Reference: DCO Guide).

Copy link

codecov bot commented Oct 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.35%. Comparing base (881d7a2) to head (d571d50).
Report is 8 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5807      +/-   ##
==========================================
+ Coverage   36.31%   36.35%   +0.03%     
==========================================
  Files        1304     1304              
  Lines      110072   110147      +75     
==========================================
+ Hits        39974    40042      +68     
- Misses      65936    65938       +2     
- Partials     4162     4167       +5     
Flag Coverage Δ
unittests-datacatalog 51.37% <ø> (ø)
unittests-flyteadmin 55.60% <ø> (ø)
unittests-flytecopilot 12.17% <ø> (ø)
unittests-flytectl 62.21% <ø> (ø)
unittests-flyteidl 7.17% <ø> (+0.04%) ⬆️
unittests-flyteplugins 53.35% <ø> (ø)
unittests-flytepropeller 42.02% <ø> (+0.10%) ⬆️
unittests-flytestdlib 55.37% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@davidmirror-ops
Copy link
Contributor

@neverett do you think the failing test here has to do with content relocation?

Signed-off-by: sumana sree <[email protected]>
@neverett
Copy link
Contributor

neverett commented Oct 7, 2024

@davidmirror-ops I don't think so, since the "Data types and I/O" section wasn't moved as part of the Flyte docs overhaul. It looks like the readthedocs test is passing and a bunch of other tests are pending -- can you point me to the test failure you're seeing?

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.

[Docs] tensorflow types: create flytesnacks example page
3 participants