From 72e43878c5c50db4b472d3b3f3b58d38456c7805 Mon Sep 17 00:00:00 2001 From: Pramod Raghavendra Jayathirth Date: Wed, 3 Nov 2021 08:26:06 +0530 Subject: [PATCH] consistent naming for better readability (#1449) * consistent naming for better readability this change is as per the discussion in the link below https://github.com/kubeflow/training-operator/pull/1418#issuecomment-925084880 * update the respective naming changes in README.md --- README.md | 6 +++--- pkg/apis/mxnet/v1/{mxjob_types.go => types.go} | 0 pkg/apis/pytorch/v1/{pytorchjob_types.go => types.go} | 0 pkg/apis/xgboost/v1/{xgboostjob_types.go => types.go} | 0 4 files changed, 3 insertions(+), 3 deletions(-) rename pkg/apis/mxnet/v1/{mxjob_types.go => types.go} (100%) rename pkg/apis/pytorch/v1/{pytorchjob_types.go => types.go} (100%) rename pkg/apis/xgboost/v1/{xgboostjob_types.go => types.go} (100%) diff --git a/README.md b/README.md index 52cf3e5225..41a93faea4 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ run distributed or non-distributed TensorFlow/PyTorch/MXNet/XGBoost jobs on Kube - For a complete reference of the custom resource definitions, please refer to the API Definition. - [Tensorflow API Definition](pkg/apis/tensorflow/v1/types.go) - - [PyTorch API Definition](pkg/apis/pytorch/v1/pytorchjob_types.go) - - [MXNet API Definition](pkg/apis/mxnet/v1/mxjob_types.go) - - [XGBoost API Definition](pkg/apis/xgboost/v1/xgboostjob_types.go) + - [PyTorch API Definition](pkg/apis/pytorch/v1/types.go) + - [MXNet API Definition](pkg/apis/mxnet/v1/types.go) + - [XGBoost API Definition](pkg/apis/xgboost/v1/types.go) - For details on API design, please refer to the [v1alpha2 design doc](https://github.com/kubeflow/community/blob/master/proposals/tf-operator-design-v1alpha2.md). - For details of all-in-one operator design, please refer to the [All-in-one Kubeflow Training Operator](https://docs.google.com/document/d/1x1JPDQfDMIbnoQRftDH1IzGU0qvHGSU4W6Jl4rJLPhI/edit#heading=h.e33ufidnl8z6) - For details on its observability, please refer to the [monitoring design doc](docs/monitoring/README.md). diff --git a/pkg/apis/mxnet/v1/mxjob_types.go b/pkg/apis/mxnet/v1/types.go similarity index 100% rename from pkg/apis/mxnet/v1/mxjob_types.go rename to pkg/apis/mxnet/v1/types.go diff --git a/pkg/apis/pytorch/v1/pytorchjob_types.go b/pkg/apis/pytorch/v1/types.go similarity index 100% rename from pkg/apis/pytorch/v1/pytorchjob_types.go rename to pkg/apis/pytorch/v1/types.go diff --git a/pkg/apis/xgboost/v1/xgboostjob_types.go b/pkg/apis/xgboost/v1/types.go similarity index 100% rename from pkg/apis/xgboost/v1/xgboostjob_types.go rename to pkg/apis/xgboost/v1/types.go