kubeflow
KEP-2170: Add Kubeflow Trainer Pipeline Framework Concept page to Documentation
What you would like to be added?
It would be great to add Kubeflow TrainerPipelineFramework documentations to https://www.kubeflow.org/docs/components/trainer/operator-guides/
Why is this needed?
We documentized the Kubeflow TrainerPipelineFramework overview and mechanism in the design documentation: https://github.com/kubeflow/trainer/blob/aece6335609e4b20abb62bdabadac30c16713d74/docs/proposals/2170-kubeflow-training-v2/README.md#pipeline-framework
It would be great to add similar documentation that is more user-friendly.
Love this feature?
Give it a 👍 We prioritize the features with most 👍
@tenzen-y
basically you will trying to say the documentation which have in the Kubeflow TrainerPipelineFramework thise will also have in -
https://www.kubeflow.org/docs/components/trainer/operator-guides/ here.
@dineshkolhe1 Yes, we should create a new page in operator guides which describe the Kubeflow Trainer pipeline framework functionality. /area docs /good-first-issue
@andreyvelich: This request has been marked as suitable for new contributors.
Please ensure the request meets the requirements listed here.
If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.
In response to this:
@dineshkolhe1 Yes, we should create a new page in operator guides which describe the Kubeflow Trainer pipeline framework functionality. /area docs /good-first-issue
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
![google-oss-prow[bot] avatar](https://avatars.githubusercontent.com/in/143327?v=4 "Published by a pub.dev verified publisher"){kind=small}
@tenzen-y basically you will trying to say the documentation which have in the Kubeflow TrainerPipelineFramework thise will also have in - https://www.kubeflow.org/docs/components/trainer/operator-guides/ here.
yeah, thats's right!
@tenzen-y Can you assign it to me? I'm learning about trainer v1 volcano and trainer v2 related concepts, this might be a good opportunity for me to familiarize myself with v2 documentation.
It seems to me that the job of this issue should be to migrate docs/proposals/2170-kubeflow-training-v2/README.md TrainerPipelineFramework under kubeflow/website/content/en/docs/components/trainer/operator-guides, is it right?
/assign @IRONICBo
It seems to me that the job of this issue should be to migrate docs/proposals/2170-kubeflow-training-v2/README.md TrainerPipelineFramework under kubeflow/website/content/en/docs/components/trainer/operator-guides, is it right?
It shouldn't be just a migration, we should discuss what doc we want to add for operator-guides in Kubeflow website.
I see, at the moment it seems that operator-guides is missing documentation for the training api, migration, etc. under 2170-kubeflow-training-v2. Maybe introduce the TrainerPipelineFramework into the website first to introduce the core flow of the V2 pipeline.
Beside, for users, the description of TrainerPipelineFramework may need to be touched up.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
This issue has been automatically closed because it has not had recent activity. Please comment "/reopen" to reopen it.
@tenzen-y: Reopened this issue.
In response to this:
/reopen
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
This has been added here: https://github.com/kubeflow/website/pull/4039 /close
@andreyvelich: Closing this issue.
In response to this:
This has been added here: https://github.com/kubeflow/website/pull/4039 /close
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.