[DOCS] Added New doc page for Flyte Type system and Data Passing #5867
Conversation
Signed-off-by: 10sharmashivam <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5867 +/- ##
==========================================
- Coverage 36.71% 34.96% -1.76%
==========================================
Files 1304 1143 -161
Lines 130081 122102 -7979
==========================================
- Hits 47764 42695 -5069
+ Misses 78147 75718 -2429
+ Partials 4170 3689 -481
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Thank you for the feedback! I’ve added the Docs link as requested: Once this PR gets approved, I intend to submit a follow-up PR in flyteorg/flytesnacks to include additional code examples under flyteorg/flytesnacks/examples/basics/basics. Once that PR is reviewed and merged, we can use the raw GitHub user content link for the examples and incorporate them into the documentation page, following the format used in other files in the documentation. I’ve also added basic sample examples in this PR to give an initial idea of how they can be incorporated into the new documentation page. Please let me know if there are any further adjustments needed! |
| :lines: 1 | ||
| ``` | ||
|
|
||
| ### When to Use the Type System |
There was a problem hiding this comment.
Not sure if this section is needed. Sounds like there are situations when you don't need to use Flyte's type system and that's not the case. This is a core construct in Flyte
| 1. Metadata: Information about the data, such as the structure of the data (e.g., data types, paths to data storage). | ||
| 2. Raw Data: The actual data itself (e.g., a Pandas DataFrame, a file in cloud storage). | ||
|
|
||
| ### How Data is Handled in Workflow Execution |
There was a problem hiding this comment.
I think this section repeats some of what is already covered here
|
@10sharmashivam thanks for volunteering, this one is not a small feat! Would you be open to have a call where we can chat more about Flyte's type system, hear your questions and then we can eventually update this PR? |
@davidmirror-ops I’d be happy to set up a call to discuss the Flyte-type system further and make sure the PR is aligned with Flyte’s core principles. I appreciate the opportunity to dive deeper into this, and I look forward to your insights! |
|
I think timezone difference will make it a bit hard (I'm on UTC-5). Tomorrow (Wednesday 23) 9:00 a.m. UTC-5 would work for you? |
|
Yes, that time works for me. Looking forward to the call. |
|
@10sharmashivam already synced with @eapolinario on this
|
|
@davidmirror-ops Thank you for the opportunity! I would be thrilled to co-author the blog post for flyte.org |
…gle meet Signed-off-by: 10sharmashivam <[email protected]>
|
Hi @davidmirror-ops, I have added content about dynamic typing & Static typing in flyte in the given doc file, starting from 3rd page. I also applied feedbacks and suggestions giving earlier, and discussed in our google meet. Like reference to related already existing docs. Doc Link And I also submitted PR, about coding examples, which can be used (when approved, and merged) as raw github user content link, serving as code example snippets in the Flyte type system documentation. Thank you! |
Signed-off-by: 10sharmashivam <[email protected]>
|
Hi @davidmirror-ops, I wanted to follow up about- Thank you! |
|
@10sharmashivam as mentioned, the idea is to work in this as a blog post (with you as co author). Wdyt? |
|
Thanks for the update, @davidmirror-ops! That sounds good to me, and I’m happy to proceed with this approach. I’ll review the existing content to align it with the blog format and make any adjustments as needed. If there’s anything specific you’d like me to focus on or add, please let me know. Thanks again for the opportunity to contribute! |
|
Sure! I'll keep adding content and comments to the shared doc |
Tracking issue
Reference #3322
Why are the changes needed?
This documentation aims to provide users with a comprehensive understanding of Flyte’s type system and data passing mechanisms, ensuring they can effectively leverage these features in their workflows.
What changes were proposed in this pull request?
Additional Comments-
I intend to submit a follow-up PR in flyteorg/flytesnacks to include additional code examples under flyteorg/flytesnacks/examples/basics/basics. Once that PR is reviewed and merged, we can use the raw GitHub user content link for the examples and incorporate them into the documentation page, following the format used in other files in the documentation.
Check all the applicable boxes