docs: updating docs for local development #2074

franciscojavierarceo · 2024-04-19T01:48:26Z

What this PR does / why we need it:

This PR updates the development guide to give instructions on how to develop locally using kind.

Which issue(s) this PR fixes (optional, in Fixes #<issue number>, #<issue number>, ... format, will close the issue(s) when PR gets merged):
Fixes # #2069

Checklist:

Docs included if any changes are user facing

examples/pytorch/mnist2/README.md

coveralls · 2024-04-19T01:56:44Z

Pull Request Test Coverage Report for Build 8840314186

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.02%) to 35.323%

Totals
Change from base Build 8839866996:	0.02%
Covered Lines:	4380
Relevant Lines:	12400

💛 - Coveralls

terrytangyuan · 2024-04-19T01:57:05Z

examples/pytorch/mnist2/mnist.py

@@ -0,0 +1,205 @@
+# Copyright 2022 The Kubeflow Authors.


Should this be PyTorch authors?

I copied this over from the demos linked so I'm just taking what they listed. I can change of course.

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

docs/development/developer_guide.md

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

tenzen-y

Thank you for creating this PR!

tenzen-y · 2024-04-19T15:14:31Z

examples/pytorch/mnist2/Dockerfile.cpu

What is the reason that this new example is needed?

In my local arm64 env, this PyTorch example worked fine since the example uses the same image:

training-operator/examples/pytorch/simple.yaml

Line 15 in 7345e33

image: docker.io/kubeflowkatib/pytorch-mnist:v1beta1-45c5727

https://github.com/kubeflow/training-operator/blob/7345e33b333ba5084127efe027774dd7bed8f6e6/examples/pytorch/simple.yaml

Did you use the master branch?

docs/development/developer_guide.md

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

docs/development/developer_guide.md

examples/pytorch/mnist2/Dockerfile.cpu

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

tenzen-y

Overall lgtm.
I left a comment for a nit.

docs/development/developer_guide.md

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

franciscojavierarceo · 2024-04-24T14:31:10Z

Overall lgtm. I left a comment for a nit.

Updated with your feedback, lmk if you want any other changes @tenzen-y! Thanks for the review!

tenzen-y

@franciscojavierarceo Thank you for this awesome contribution 🎉
/lgtm
/approve

/hold
for CI

andreyvelich

Thank you for this great contribution @franciscojavierarceo!

I left a few comments.

docs/development/developer_guide.md

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

franciscojavierarceo · 2024-04-26T00:22:51Z

Tests are passing now 👍

tenzen-y

Thank you!
/lgtm
/approve
/hold cancel

google-oss-prow · 2024-04-26T05:58:38Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: franciscojavierarceo, tenzen-y

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [tenzen-y]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

* adding new demo for arm64 and updating docs for local development Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * updated cpu Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * updated readme to add link to pytorch Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * removed links Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * fixed typo Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * adjusting based on feedback from Yuki Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * Removing the make run command from developer guide Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * updated dev docs with lates notes Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * Removing mnist2 example Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * added requirements to developer guide Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * adding link to Lima Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * moved note about namesapce Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> --------- Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> Signed-off-by: Weiyu Yen <ckyuto@gmail.com>

* adding new demo for arm64 and updating docs for local development Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * updated cpu Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * updated readme to add link to pytorch Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * removed links Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * fixed typo Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * adjusting based on feedback from Yuki Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * Removing the make run command from developer guide Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * updated dev docs with lates notes Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * Removing mnist2 example Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * added requirements to developer guide Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * adding link to Lima Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> * moved note about namesapce Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com> --------- Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

google-oss-prow bot requested review from jinchihe and kuizhiqing April 19, 2024 01:48

google-oss-prow bot added the size/L label Apr 19, 2024

terrytangyuan reviewed Apr 19, 2024

View reviewed changes

examples/pytorch/mnist2/README.md Outdated Show resolved Hide resolved

terrytangyuan reviewed Apr 19, 2024

View reviewed changes

franciscojavierarceo added 2 commits April 18, 2024 22:23

adding new demo for arm64 and updating docs for local development

2cf5371

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

updated cpu

db59a4e

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

franciscojavierarceo force-pushed the update-dev-guide branch from 5350ad3 to db59a4e Compare April 19, 2024 02:23

franciscojavierarceo added 2 commits April 18, 2024 22:25

updated readme to add link to pytorch

effdcbe

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

removed links

e964f35

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

kellyaa reviewed Apr 19, 2024

View reviewed changes

docs/development/developer_guide.md Outdated Show resolved Hide resolved

fixed typo

e191745

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

tenzen-y reviewed Apr 19, 2024

View reviewed changes

franciscojavierarceo added 3 commits April 19, 2024 12:08

adjusting based on feedback from Yuki

ceabde8

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

Removing the make run command from developer guide

ce4dca1

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

updated dev docs with lates notes

e6ddc14

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

tariq-hasan reviewed Apr 19, 2024

View reviewed changes

docs/development/developer_guide.md Show resolved Hide resolved

tariq-hasan reviewed Apr 19, 2024

View reviewed changes

docs/development/developer_guide.md Show resolved Hide resolved

tenzen-y reviewed Apr 22, 2024

View reviewed changes

examples/pytorch/mnist2/Dockerfile.cpu Outdated Show resolved Hide resolved

Removing mnist2 example

44f3cab

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

franciscojavierarceo changed the title ~~adding new demo for arm64 and updating docs for local development~~ docs: updating docs for local development Apr 23, 2024

added requirements to developer guide

f6f7c33

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

tenzen-y reviewed Apr 24, 2024

View reviewed changes

docs/development/developer_guide.md Outdated Show resolved Hide resolved

docs/development/developer_guide.md Show resolved Hide resolved

adding link to Lima

c9399a8

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

tenzen-y reviewed Apr 24, 2024

View reviewed changes

google-oss-prow bot added the do-not-merge/hold label Apr 24, 2024

google-oss-prow bot assigned tenzen-y Apr 24, 2024

google-oss-prow bot added the lgtm label Apr 24, 2024

google-oss-prow bot added the approved label Apr 24, 2024

andreyvelich reviewed Apr 24, 2024

View reviewed changes

moved note about namesapce

f6cbf7c

Signed-off-by: Francisco Javier Arceo <4163062+franciscojavierarceo@users.noreply.github.com>

google-oss-prow bot removed the lgtm label Apr 24, 2024

franciscojavierarceo mentioned this pull request Apr 25, 2024

Update developer guide to handle missing training-operator-webhook-cert #2069

Closed

franciscojavierarceo added 2 commits April 25, 2024 12:24

Merge branch 'kubeflow:master' into update-dev-guide

d484eb0

Merge branch 'kubeflow:master' into update-dev-guide

ea1066c

tenzen-y reviewed Apr 26, 2024

View reviewed changes

google-oss-prow bot added lgtm and removed do-not-merge/hold labels Apr 26, 2024

google-oss-prow bot merged commit 73eb699 into kubeflow:master Apr 26, 2024
38 checks passed

franciscojavierarceo mentioned this pull request May 9, 2024

Update org.yaml kubeflow/internal-acls#679

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: updating docs for local development #2074

docs: updating docs for local development #2074

franciscojavierarceo commented Apr 19, 2024 •

edited

Loading

coveralls commented Apr 19, 2024 •

edited

Loading

terrytangyuan Apr 19, 2024

franciscojavierarceo Apr 19, 2024

tenzen-y left a comment

tenzen-y Apr 19, 2024

tenzen-y left a comment

franciscojavierarceo commented Apr 24, 2024

tenzen-y left a comment

andreyvelich left a comment

franciscojavierarceo commented Apr 26, 2024

tenzen-y left a comment

google-oss-prow bot commented Apr 26, 2024

docs: updating docs for local development #2074

docs: updating docs for local development #2074

Conversation

franciscojavierarceo commented Apr 19, 2024 • edited Loading

coveralls commented Apr 19, 2024 • edited Loading

Pull Request Test Coverage Report for Build 8840314186

Details

💛 - Coveralls

terrytangyuan Apr 19, 2024

Choose a reason for hiding this comment

franciscojavierarceo Apr 19, 2024

Choose a reason for hiding this comment

tenzen-y left a comment

Choose a reason for hiding this comment

tenzen-y Apr 19, 2024

Choose a reason for hiding this comment

tenzen-y left a comment

Choose a reason for hiding this comment

franciscojavierarceo commented Apr 24, 2024

tenzen-y left a comment

Choose a reason for hiding this comment

andreyvelich left a comment

Choose a reason for hiding this comment

franciscojavierarceo commented Apr 26, 2024

tenzen-y left a comment

Choose a reason for hiding this comment

google-oss-prow bot commented Apr 26, 2024

franciscojavierarceo commented Apr 19, 2024 •

edited

Loading

coveralls commented Apr 19, 2024 •

edited

Loading