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.

Sign up for GitHub

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

Jump to bottom

[Docs] add additional documentation for the with_overrides feature #4067

Open
2 tasks done
Tracked by #4064
samhita-alla opened this issue Sep 25, 2023 · 8 comments · May be fixed by flyteorg/flytesnacks#1181
Open
2 tasks done
Tracked by #4064

[Docs] add additional documentation for the with_overrides feature #4067

samhita-alla opened this issue Sep 25, 2023 · 8 comments · May be fixed by flyteorg/flytesnacks#1181
Assignees
@dado5688
Labels
documentation Improvements or additions to documentation pri2

Comments

@samhita-alla
Copy link
Contributor

samhita-alla commented Sep 25, 2023 •
edited by neverett
Loading

Description

Extend the with_overrides section in the documentation to document all parameters to the with_overrides method. In particular, demonstrate how it can be used to dynamically update various task configurations within task_config, not just requests and limits.

Reference Slack threads:

Are you sure this issue hasn't been raised already?

  • Yes

Have you read the Code of Conduct?

  • Yes
@samhita-alla samhita-alla added documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers labels Sep 25, 2023
@samhita-alla samhita-alla changed the title [Docs] add more documentation on with_overrides [Docs] add additional documentation for the with_overrides feature Sep 25, 2023
@samhita-alla samhita-alla added hacktoberfest and removed untriaged This issues has not yet been looked at by the Maintainers labels Sep 25, 2023
@samhita-alla samhita-alla mentioned this issue Sep 25, 2023
Open
45 tasks
@neelshah2409
Copy link

Hey @samhita-alla I would like to work on it .

@Vishalk91-4
Copy link

@samhita-alla, can you please assign this issue to me

@samhita-alla
Copy link
Contributor Author

Please go ahead and create a PR, @neelshah2409, @Vishalk91-4. We will prioritize PRs based on a first-come, first-serve approach.

@itssiddhantjain
Copy link

Hello @samhita-alla , please assign this issue to me as I have already worked on this kind of problem in past and has a great experience.

@dado5688 dado5688 linked a pull request Oct 12, 2023 that will close this issue
Open
@dado5688
Copy link

Hello @samhita-alla , please assign this issue to me since I have already create a PR for this issue.
thanks a lot !

@neverett
Copy link
Contributor

neverett commented Nov 1, 2023

There was a question about the name parameter of with_overrides in Slack, so we may want to update this section to document all parameters, even though it's technically about resource allocation. @samhita-alla @dado5688 does that sound OK to you? I can open a separate issue if we want to keep this issue and related PR focused on documenting task_config.

@samhita-alla
Copy link
Contributor Author

@neverett, I'm not sure if we're going to merge the linked PR 'cause @dado5688 hasn't yet worked on the changes I suggested. We can definitely work on documenting all the parameters as part of this issue. Please feel free to change the description.

@GeeCastro
Copy link

Just reviving this as I found .with_overrides(name="my_name") super useful for repurposing a task in the same ML workflow (processing train set and test sets separately)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dado5688 dado5688

Labels
documentation Improvements or additions to documentation pri2
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add additional documentation for the with_overrides feature dado5688/flytesnacks
7 participants
@neverett @GeeCastro @samhita-alla @neelshah2409 @itssiddhantjain @Vishalk91-4 @dado5688