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

Added new page under Data types and IO section for tensorflow_types in flyte documentation #5807

Merged
merged 11 commits into from
Oct 31, 2024

Conversation

sumana-2705
Copy link
Contributor

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).

@davidmirror-ops davidmirror-ops self-requested a review October 4, 2024 20:49
Copy link

codecov bot commented Oct 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.84%. Comparing base (2b0af2b) to head (4524897).
Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5807      +/-   ##
==========================================
- Coverage   36.84%   36.84%   -0.01%     
==========================================
  Files        1309     1309              
  Lines      130994   130994              
==========================================
- Hits        48271    48268       -3     
- Misses      78533    78536       +3     
  Partials     4190     4190              
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.10% <ø> (ø)
unittests-flytecopilot 11.73% <ø> (ø)
unittests-flytectl 62.40% <ø> (-0.05%) ⬇️
unittests-flyteidl 6.92% <ø> (ø)
unittests-flyteplugins 53.64% <ø> (ø)
unittests-flytepropeller 43.02% <ø> (ø)
unittests-flytestdlib 55.41% <ø> (+0.01%) ⬆️

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?

@sumana-2705 sumana-2705 changed the title Trying to add a new page under Data types and IO section for tensorfl… Added new page under Data types and IO section for tensorfl… Oct 17, 2024
@sumana-2705 sumana-2705 changed the title Added new page under Data types and IO section for tensorfl… Added new page under Data types and IO section for tensorflow_types in flyte documentation Oct 17, 2024
Copy link
Contributor

@davidmirror-ops davidmirror-ops left a comment

Choose a reason for hiding this comment

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

Thank you!

Signed-off-by: Sumana Sree Angajala <[email protected]>
@sumana-2705
Copy link
Contributor Author

@davidmirror-ops I'm so sorry, I have just tried to fix the errors in the tests. I don't know that it would cancel the approval. I'm unaware of that. Please don't mind my mistake.

neverett
neverett previously approved these changes Oct 18, 2024
Copy link
Contributor

@neverett neverett left a comment

Choose a reason for hiding this comment

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

Added a few suggestions, but otherwise this looks good to me. Feel free to request another review from me after you're done making changes!

docs/user_guide/data_types_and_io/tensorflow_type.md Outdated Show resolved Hide resolved
docs/user_guide/data_types_and_io/tensorflow_type.md Outdated Show resolved Hide resolved
docs/user_guide/data_types_and_io/tensorflow_type.md Outdated Show resolved Hide resolved
docs/user_guide/data_types_and_io/tensorflow_type.md Outdated Show resolved Hide resolved
docs/user_guide/data_types_and_io/tensorflow_type.md Outdated Show resolved Hide resolved
@sumana-2705
Copy link
Contributor Author

@neverett I have included the changes can you please review it now.

@sumana-2705 sumana-2705 requested a review from neverett October 18, 2024 17:27
@sumana-2705
Copy link
Contributor Author

@davidmirror-ops, I have updated my forked repository to the latest commits; could you please proceed with merging this PR?

@davidmirror-ops davidmirror-ops merged commit dcdd472 into flyteorg:master Oct 31, 2024
50 of 51 checks passed
@sumana-2705 sumana-2705 deleted the tensorflow_types_new_page branch October 31, 2024 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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