mirror of
https://github.com/hanzo-ml/katib.git
synced 2026-09-24 00:31:27 +00:00
Yuki IwaiandGitHub
71ee0464c0
* Implement KatibConfig API Signed-off-by: Yuki Iwai <[email protected]> * Replace 'collectorKind' with 'kind' Signed-off-by: Yuki Iwai <[email protected]> * Replace 'metricsCollectorSidecars' with 'metricsCollectors' Signed-off-by: Yuki Iwai <[email protected]> * Fix a typo Signed-off-by: Yuki Iwai <[email protected]> * Make the init.controller.leaderElection non-pointer Signed-off-by: Yuki Iwai <[email protected]> * Make the init.controller.injectSecurityContext non-pointer Signed-off-by: Yuki Iwai <[email protected]> * Update a comment for the future works Signed-off-by: Yuki Iwai <[email protected]> * Update manifest for the katib-leader-election Signed-off-by: Yuki Iwai <[email protected]> * Fix a comment for the KatibConfig API Signed-off-by: Yuki Iwai <[email protected]> * Replace 'configapi' with 'configv1beta1' Signed-off-by: Yuki Iwai <[email protected]> * Remove debug code Signed-off-by: Yuki Iwai <[email protected]> * Put constant for the default KatibConfig value on /pkg/apis/config/v1beta1 Signed-off-by: Yuki Iwai <[email protected]> * Use 'sigs.k8s.io/yaml' instead of 'github.com/ghodss/yaml' Signed-off-by: Yuki Iwai <[email protected]> * Avoid to depend on k8s.io/utils directly Signed-off-by: Yuki Iwai <[email protected]> * Fix a typo Signed-off-by: Yuki Iwai <[email protected]> * Refactor katib-config using kustomize vars Signed-off-by: Yuki Iwai <[email protected]> * Fix a typo Signed-off-by: Yuki Iwai <[email protected]> * Put KatibConfig on every install Signed-off-by: Yuki Iwai <[email protected]> * Remove configMapGenerator from the katib-with-kubeflow Signed-off-by: Yuki Iwai <[email protected]> --------- Signed-off-by: Yuki Iwai <[email protected]>
178 lines
6.6 KiB
Makefile
Executable File
178 lines
6.6 KiB
Makefile
Executable File
HAS_LINT := $(shell command -v golangci-lint;)
|
|
HAS_YAMLLINT := $(shell command -v yamllint;)
|
|
HAS_SHELLCHECK := $(shell command -v shellcheck;)
|
|
HAS_SETUP_ENVTEST := $(shell command -v setup-envtest;)
|
|
HAS_MOCKGEN := $(shell command -v mockgen;)
|
|
|
|
COMMIT := v1beta1-$(shell git rev-parse --short=7 HEAD)
|
|
KATIB_REGISTRY := docker.io/kubeflowkatib
|
|
CPU_ARCH ?= amd64
|
|
ENVTEST_K8S_VERSION ?= 1.27
|
|
MOCKGEN_VERSION ?= $(shell grep 'github.com/golang/mock' go.mod | cut -d ' ' -f 2)
|
|
GO_VERSION=$(shell grep '^go' go.mod | cut -d ' ' -f 2)
|
|
|
|
# for pytest
|
|
PYTHONPATH := $(PYTHONPATH):$(CURDIR)/pkg/apis/manager/v1beta1/python:$(CURDIR)/pkg/apis/manager/health/python
|
|
PYTHONPATH := $(PYTHONPATH):$(CURDIR)/pkg/metricscollector/v1beta1/common:$(CURDIR)/pkg/metricscollector/v1beta1/tfevent-metricscollector
|
|
TEST_TENSORFLOW_EVENT_FILE_PATH ?= $(CURDIR)/test/unit/v1beta1/metricscollector/testdata/tfevent-metricscollector/logs
|
|
|
|
# Run tests
|
|
.PHONY: test
|
|
test: envtest
|
|
KUBEBUILDER_ASSETS="$(shell setup-envtest --arch=amd64 use $(ENVTEST_K8S_VERSION) -p path)" go test ./pkg/... ./cmd/... -coverprofile coverage.out
|
|
|
|
envtest:
|
|
ifndef HAS_SETUP_ENVTEST
|
|
go install sigs.k8s.io/controller-runtime/tools/setup-envtest@935faeba70039b5403616e73f109f4b6b1115b9f #v0.15.0
|
|
$(info "setup-envtest has been installed")
|
|
endif
|
|
$(info "setup-envtest has already installed")
|
|
|
|
check: generated-codes go-mod fmt vet lint
|
|
|
|
fmt:
|
|
hack/verify-gofmt.sh
|
|
|
|
lint:
|
|
ifndef HAS_LINT
|
|
go install github.com/golangci/golangci-lint/cmd/[email protected]
|
|
$(info "golangci-lint has been installed")
|
|
endif
|
|
hack/verify-golangci-lint.sh
|
|
|
|
yamllint:
|
|
ifndef HAS_YAMLLINT
|
|
pip install --prefer-binary yamllint
|
|
$(info "yamllint has been installed")
|
|
endif
|
|
hack/verify-yamllint.sh
|
|
|
|
vet:
|
|
go vet ./pkg/... ./cmd/...
|
|
|
|
shellcheck:
|
|
ifndef HAS_SHELLCHECK
|
|
bash hack/install-shellcheck.sh
|
|
$(info "shellcheck has been installed")
|
|
endif
|
|
hack/verify-shellcheck.sh
|
|
|
|
update:
|
|
hack/update-gofmt.sh
|
|
|
|
# Deploy Katib v1beta1 manifests using Kustomize into a k8s cluster.
|
|
deploy:
|
|
bash scripts/v1beta1/deploy.sh $(WITH_DATABASE_TYPE)
|
|
|
|
# Undeploy Katib v1beta1 manifests using Kustomize from a k8s cluster
|
|
undeploy:
|
|
bash scripts/v1beta1/undeploy.sh
|
|
|
|
generated-codes: generate
|
|
ifneq ($(shell bash hack/verify-generated-codes.sh '.'; echo $$?),0)
|
|
$(error 'Please run "make generate" to generate codes')
|
|
endif
|
|
|
|
go-mod: sync-go-mod
|
|
ifneq ($(shell bash hack/verify-generated-codes.sh 'go.*'; echo $$?),0)
|
|
$(error 'Please run "go mod tidy -go $(GO_VERSION)" to sync Go modules')
|
|
endif
|
|
|
|
sync-go-mod:
|
|
go mod tidy -go $(GO_VERSION)
|
|
|
|
CONTROLLER_GEN = $(shell pwd)/bin/controller-gen
|
|
.PHONY: controller-gen
|
|
controller-gen:
|
|
@GOBIN=$(shell pwd)/bin GO111MODULE=on go install sigs.k8s.io/controller-tools/cmd/[email protected]
|
|
|
|
# Run this if you update any existing controller APIs.
|
|
# 1. Generate deepcopy, clientset, listers, informers for the APIs (hack/update-codegen.sh)
|
|
# 2. Generate open-api for the APIs (hack/update-openapigen)
|
|
# 3. Generate Python SDK for Katib (hack/gen-python-sdk/gen-sdk.sh)
|
|
# 4. Generate gRPC manager APIs (pkg/apis/manager/v1beta1/build.sh and pkg/apis/manager/health/build.sh)
|
|
# 5. Generate Go mock codes
|
|
generate: controller-gen
|
|
ifndef GOPATH
|
|
$(error GOPATH not defined, please define GOPATH. Run "go help gopath" to learn more about GOPATH)
|
|
endif
|
|
ifndef HAS_MOCKGEN
|
|
go install github.com/golang/mock/mockgen@$(MOCKGEN_VERSION)
|
|
$(info "mockgen has been installed")
|
|
endif
|
|
go generate ./pkg/... ./cmd/...
|
|
hack/gen-python-sdk/gen-sdk.sh
|
|
pkg/apis/manager/v1beta1/build.sh
|
|
pkg/apis/manager/health/build.sh
|
|
hack/update-mockgen.sh
|
|
|
|
# Build images for the Katib v1beta1 components.
|
|
build: generate
|
|
ifeq ($(and $(REGISTRY),$(TAG),$(CPU_ARCH)),)
|
|
$(error REGISTRY and TAG must be set. Usage: make build REGISTRY=<registry> TAG=<tag> CPU_ARCH=<cpu-architecture>)
|
|
endif
|
|
bash scripts/v1beta1/build.sh $(REGISTRY) $(TAG) $(CPU_ARCH)
|
|
|
|
# Build and push Katib images from the latest master commit.
|
|
push-latest: generate
|
|
bash scripts/v1beta1/build.sh $(KATIB_REGISTRY) latest $(CPU_ARCH)
|
|
bash scripts/v1beta1/build.sh $(KATIB_REGISTRY) $(COMMIT) $(CPU_ARCH)
|
|
bash scripts/v1beta1/push.sh $(KATIB_REGISTRY) latest
|
|
bash scripts/v1beta1/push.sh $(KATIB_REGISTRY) $(COMMIT)
|
|
|
|
# Build and push Katib images for the given tag.
|
|
push-tag: generate
|
|
ifeq ($(TAG),)
|
|
$(error TAG must be set. Usage: make push-tag TAG=<release-tag>)
|
|
endif
|
|
bash scripts/v1beta1/build.sh $(KATIB_REGISTRY) $(TAG) $(CPU_ARCH)
|
|
bash scripts/v1beta1/build.sh $(KATIB_REGISTRY) $(COMMIT) $(CPU_ARCH)
|
|
bash scripts/v1beta1/push.sh $(KATIB_REGISTRY) $(TAG)
|
|
bash scripts/v1beta1/push.sh $(KATIB_REGISTRY) $(COMMIT)
|
|
|
|
# Release a new version of Katib.
|
|
release:
|
|
ifeq ($(and $(BRANCH),$(TAG)),)
|
|
$(error BRANCH and TAG must be set. Usage: make release BRANCH=<branch> TAG=<tag>)
|
|
endif
|
|
bash scripts/v1beta1/release.sh $(BRANCH) $(TAG)
|
|
|
|
# Update all Katib images.
|
|
update-images:
|
|
ifeq ($(and $(OLD_PREFIX),$(NEW_PREFIX),$(TAG)),)
|
|
$(error OLD_PREFIX, NEW_PREFIX, and TAG must be set. \
|
|
Usage: make update-images OLD_PREFIX=<old-prefix> NEW_PREFIX=<new-prefix> TAG=<tag> \
|
|
For more information, check this file: scripts/v1beta1/update-images.sh)
|
|
endif
|
|
bash scripts/v1beta1/update-images.sh $(OLD_PREFIX) $(NEW_PREFIX) $(TAG)
|
|
|
|
# Prettier UI format check for Katib v1beta1.
|
|
prettier-check:
|
|
npm run format:check --prefix pkg/ui/v1beta1/frontend
|
|
|
|
# Update boilerplate for the source code.
|
|
update-boilerplate:
|
|
./hack/boilerplate/update-boilerplate.sh
|
|
|
|
prepare-pytest:
|
|
pip install --prefer-binary -r test/unit/v1beta1/requirements.txt
|
|
pip install --prefer-binary -r cmd/suggestion/hyperopt/v1beta1/requirements.txt
|
|
pip install --prefer-binary -r cmd/suggestion/skopt/v1beta1/requirements.txt
|
|
pip install --prefer-binary -r cmd/suggestion/optuna/v1beta1/requirements.txt
|
|
pip install --prefer-binary -r cmd/suggestion/hyperband/v1beta1/requirements.txt
|
|
pip install --prefer-binary -r cmd/suggestion/nas/enas/v1beta1/requirements.txt
|
|
pip install --prefer-binary -r cmd/suggestion/nas/darts/v1beta1/requirements.txt
|
|
pip install --prefer-binary -r cmd/suggestion/pbt/v1beta1/requirements.txt
|
|
pip install --prefer-binary -r cmd/earlystopping/medianstop/v1beta1/requirements.txt
|
|
pip install --prefer-binary -r cmd/metricscollector/v1beta1/tfevent-metricscollector/requirements.txt
|
|
|
|
prepare-pytest-testdata:
|
|
ifeq ("$(wildcard $(TEST_TENSORFLOW_EVENT_FILE_PATH))", "")
|
|
python examples/v1beta1/trial-images/tf-mnist-with-summaries/mnist.py --epochs 5 --batch-size 200 --log-path $(TEST_TENSORFLOW_EVENT_FILE_PATH)
|
|
endif
|
|
|
|
pytest: prepare-pytest prepare-pytest-testdata
|
|
PYTHONPATH=$(PYTHONPATH) pytest ./test/unit/v1beta1/suggestion
|
|
PYTHONPATH=$(PYTHONPATH) pytest ./test/unit/v1beta1/earlystopping
|
|
PYTHONPATH=$(PYTHONPATH) pytest ./test/unit/v1beta1/metricscollector
|