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

docs: add nested_type example in data_types_and_io/structured_dataset.py #5269

Merged

Conversation

austin362667
Copy link
Contributor

@austin362667 austin362667 commented Apr 23, 2024

Tracking issue

#4241
flyteorg/flytekit#2252
flyteorg/flytesnacks#1657

Why are the changes needed?

Add structured_dataset_nested_type examples in documentation.

flyteorg/flytekit#2252

What changes were proposed in this pull request?

Demonstrate how to use nested_types in structured_dataset

How was this patch tested?

https://github.com/flyteorg/flytekit/pull/2252/files#diff-e78d93a6e6cd2463cd5fc51973434c29ece29d05fe6b36691d6d19860386f938

Setup process

make dev-docs

Screenshots

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

flyteorg/flytekit#2252
flyteorg/flytesnacks#1657

Docs link

https://flyte--5269.org.readthedocs.build/en/5269/user_guide/data_types_and_io/structureddataset.html#structured-dataset

@austin362667 austin362667 changed the title docs: add structured_dataset_workflow_with_nested_type docs: add nested_type example in data_types_and_io/structured_dataset.py Apr 23, 2024
neverett
neverett previously approved these changes Apr 23, 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.

Two small suggestions, otherwise LGTM

neverett
neverett previously approved these changes Apr 29, 2024
Copy link

codecov bot commented Apr 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.10%. Comparing base (5cfd004) to head (d6230d5).
Report is 7 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5269   +/-   ##
=======================================
  Coverage   61.10%   61.10%           
=======================================
  Files         794      794           
  Lines       51213    51213           
=======================================
  Hits        31295    31295           
  Misses      17037    17037           
  Partials     2881     2881           
Flag Coverage Δ
unittests-datacatalog 69.31% <ø> (ø)
unittests-flyteadmin 58.90% <ø> (ø)
unittests-flytecopilot 17.79% <ø> (ø)
unittests-flytectl 68.30% <ø> (ø)
unittests-flyteidl 79.30% <ø> (ø)
unittests-flyteplugins 61.94% <ø> (ø)
unittests-flytepropeller 57.32% <ø> (ø)
unittests-flytestdlib 65.75% <ø> (ø)

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.

austin362667 and others added 5 commits May 7, 2024 12:06
@austin362667 austin362667 force-pushed the austin362667/sd_nested_types branch from 1e8962e to 5c3906d Compare May 7, 2024 04:07
Signed-off-by: Austin Liu <[email protected]>

update line numbers

Signed-off-by: Austin Liu <[email protected]>
@austin362667 austin362667 force-pushed the austin362667/sd_nested_types branch from 5c3906d to 77aa4e4 Compare May 7, 2024 04:10
Copy link
Member

@Future-Outlier Future-Outlier left a comment

Choose a reason for hiding this comment

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

Signed-off-by: Austin Liu <[email protected]>
@Future-Outlier Future-Outlier merged commit 41b1b84 into flyteorg:master May 9, 2024
48 checks passed
robert-ulbrich-mercedes-benz pushed a commit to robert-ulbrich-mercedes-benz/flyte that referenced this pull request Jul 2, 2024
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.

4 participants