[Docs] Rename container_image to image for improved UX#6211
Conversation
Signed-off-by: JiangJiaWei1103 <[email protected]>
Code Review Agent Run Status
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6211 +/- ##
=======================================
Coverage 36.90% 36.90%
=======================================
Files 1317 1317
Lines 134061 134061
=======================================
+ Hits 49474 49479 +5
+ Misses 80294 80289 -5
Partials 4293 4293
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| you can specify rules for binding container images. By default, flytekit binds a single container image, i.e., | ||
| the [default Docker image](https://ghcr.io/flyteorg/flytekit), to all tasks. To modify this behavior, | ||
| use the `container_image` parameter available in the {py:func}`flytekit.task` decorator, and pass an | ||
| use the `image` parameter available in the {py:func}`flytekit.task` decorator, and pass an |
There was a problem hiding this comment.
Not sure I follow
I still see container_image as the arg name in the task API
https://docs.flyte.org/en/latest/api/flytekit/generated/flytekit.task.html
I think there's some discussion around changing it to be image indeed but not in effect AFAIK
There was a problem hiding this comment.
Hi @davidmirror-ops,
Great catch! I just completed the final modification in flyteorg/flytekit#3094 and I believe it'll be merged soon. Thanks!
wild-endeavor
left a comment
wild-endeavor
left a comment
There was a problem hiding this comment.
+1 but please don't merge this until there's a deployed change (non-beta) in flytekit.
docs can be merged after the official Flyte release is out so it's okay to be a little delayed.
Thanks!
5 participants
Tracking issue
NA
Why are the changes needed?
To enhance the user experience, the concept of
containershould be abstracted from flytekit users.What changes were proposed in this pull request?
Rename
container_imagetoimageforflytekit.task()decorator.Check all the applicable boxes
Related PRs
flyteorg/flytekit#3094
Docs link