Makefile 7.57 KB
Newer Older
liuzhe-lz's avatar
liuzhe-lz committed
1
# Setting variables
2
SHELL := /bin/bash
Zejun Lin's avatar
Zejun Lin committed
3
PIP_INSTALL := python3 -m pip install --no-cache-dir
Gems Guo's avatar
Gems Guo committed
4
PIP_UNINSTALL := python3 -m pip uninstall
liuzhe-lz's avatar
liuzhe-lz committed
5

Gems Guo's avatar
Gems Guo committed
6
## Colorful output
7
8
9
_INFO := $(shell echo -e '\033[1;36m')
_WARNING := $(shell echo -e '\033[1;33m')
_END := $(shell echo -e '\033[0m')
Gems Guo's avatar
Gems Guo committed
10
11

## Detect OS
12
13
UNAME_S := $(shell uname -s)
ifeq ($(UNAME_S), Linux)
14
    OS_SPEC := linux
15
else ifeq ($(UNAME_S), Darwin)
16
    OS_SPEC := darwin
17
18
19
20
else
	$(error platform $(UNAME_S) not supported)
endif

liuzhe-lz's avatar
liuzhe-lz committed
21
## Install directories
22
23
24
ROOT_FOLDER ?= $(shell python3 -c 'import site; from pathlib import Path; print(Path(site.getsitepackages()[0]).parents[2])')
IS_SYS_PYTHON ?= $(shell [[ $(ROOT_FOLDER) == /usr* || $(ROOT_FOLDER) == /Library* ]] && echo TRUE || echo FALSE)

liuzhe-lz's avatar
liuzhe-lz committed
25
26
ifeq ($(shell id -u), 0)  # is root
    _ROOT := 1
27
    BASH_COMP_PREFIX ?= /usr/share/bash-completion/completions
liuzhe-lz's avatar
liuzhe-lz committed
28
else  # is normal user
29
30
31
    ifeq (TRUE, $(IS_SYS_PYTHON))
        ROOT_FOLDER := $(shell python3 -c 'import site; from pathlib import Path; print(Path(site.getusersitepackages()).parents[2])')
    endif
liuzhe-lz's avatar
liuzhe-lz committed
32
    ifndef VIRTUAL_ENV
33
34
35
        ifeq (, $(shell echo $$PATH | grep 'conda'))
            PIP_MODE ?= --user
        endif
liuzhe-lz's avatar
liuzhe-lz committed
36
    endif
37
    BASH_COMP_PREFIX ?= ${HOME}/.bash_completion.d
38
endif
39
40
41
BASH_COMP_SCRIPT := $(BASH_COMP_PREFIX)/nnictl

NNI_INSTALL_PATH ?= $(INSTALL_PREFIX)/nni
Deshui Yu's avatar
Deshui Yu committed
42

Gems Guo's avatar
Gems Guo committed
43
BIN_FOLDER ?= $(ROOT_FOLDER)/bin
Gems Guo's avatar
Gems Guo committed
44
NNI_PKG_FOLDER ?= $(ROOT_FOLDER)/nni
Gems Guo's avatar
Gems Guo committed
45

liuzhe-lz's avatar
liuzhe-lz committed
46
## Dependency information
47
48
49
50
NNI_DEPENDENCY_FOLDER = /tmp/$(USER)
$(shell mkdir -p $(NNI_DEPENDENCY_FOLDER))
NNI_NODE_TARBALL ?= $(NNI_DEPENDENCY_FOLDER)/nni-node-$(OS_SPEC)-x64.tar.xz
NNI_NODE_FOLDER = $(NNI_DEPENDENCY_FOLDER)/nni-node-$(OS_SPEC)-x64
51
NNI_NODE ?= $(BIN_FOLDER)/node
52
53
NNI_YARN_TARBALL ?= $(NNI_DEPENDENCY_FOLDER)/nni-yarn.tar.gz
NNI_YARN_FOLDER ?= $(NNI_DEPENDENCY_FOLDER)/nni-yarn
54
NNI_YARN := PATH=$(BIN_FOLDER):$${PATH} $(NNI_YARN_FOLDER)/bin/yarn
liuzhe-lz's avatar
liuzhe-lz committed
55

Gems Guo's avatar
Gems Guo committed
56
## Version number
goooxu's avatar
goooxu committed
57
58
NNI_VERSION_VALUE = $(shell git describe --tags)
NNI_VERSION_TEMPLATE = 999.0.0-developing
Gems Guo's avatar
Gems Guo committed
59

liuzhe-lz's avatar
liuzhe-lz committed
60
61
62
# Main targets

.PHONY: build
Deshui Yu's avatar
Deshui Yu committed
63
build:
liuzhe-lz's avatar
liuzhe-lz committed
64
	#$(_INFO) Building NNI Manager $(_END)
Zejun Lin's avatar
Zejun Lin committed
65
	cd src/nni_manager && $(NNI_YARN) && $(NNI_YARN) build
goooxu's avatar
goooxu committed
66
	#$(_INFO) Building WebUI $(_END)
Zejun Lin's avatar
Zejun Lin committed
67
	cd src/webui && $(NNI_YARN) && $(NNI_YARN) build
Deshui Yu's avatar
Deshui Yu committed
68

liuzhe-lz's avatar
liuzhe-lz committed
69
# All-in-one target for non-expert users
liuzhe-lz's avatar
liuzhe-lz committed
70
71
72
73
74
# Installs NNI as well as its dependencies, and update bashrc to set PATH
.PHONY: easy-install
easy-install: check-perm
easy-install: install-dependencies
easy-install: build
liuzhe-lz's avatar
liuzhe-lz committed
75
easy-install: install
liuzhe-lz's avatar
liuzhe-lz committed
76
easy-install: update-bash-config
liuzhe-lz's avatar
liuzhe-lz committed
77
easy-install:
Zejun Lin's avatar
Zejun Lin committed
78
	#$(_INFO) Complete! $(_END)
liuzhe-lz's avatar
liuzhe-lz committed
79

Gems Guo's avatar
Gems Guo committed
80
81
82
83
84
85
86
87
88
89
# All-in-one target for developer users
# Install NNI as well as its dependencies, and update bashrc to set PATH
.PHONY: dev-easy-install
dev-easy-install: dev-check-perm
dev-easy-install: install-dependencies
dev-easy-install: build
dev-easy-install: dev-install
dev-easy-install: update-bash-config
dev-easy-install:
	#$(_INFO) Complete! $(_END)
liuzhe-lz's avatar
liuzhe-lz committed
90

Gems Guo's avatar
Gems Guo committed
91
92
93
94
95
96
97
98
# Standard installation target
# Must be invoked after building
.PHONY: install
install: install-python-modules
install: install-node-modules
install: install-scripts
install:
	#$(_INFO) Complete! You may want to add $(BIN_FOLDER) to your PATH environment $(_END)
liuzhe-lz's avatar
liuzhe-lz committed
99
100
101
102

# Target for NNI developers
# Creates symlinks instead of copying files
.PHONY: dev-install
Gems Guo's avatar
Gems Guo committed
103
104
dev-install: dev-install-python-modules
dev-install: dev-install-node-modules
liuzhe-lz's avatar
liuzhe-lz committed
105
106
dev-install: install-scripts
dev-install:
107
	#$(_INFO) Complete! You may want to add $(BIN_FOLDER) to your PATH environment $(_END)
liuzhe-lz's avatar
liuzhe-lz committed
108

Gems Guo's avatar
Gems Guo committed
109
110
111
112
113
114
115
116
# Target for setup.py
# Do not invoke this manually
.PHONY: pip-install
pip-install: install-dependencies
pip-install: build
pip-install: install-node-modules
pip-install: install-scripts
pip-install: update-bash-config
liuzhe-lz's avatar
liuzhe-lz committed
117
118
119

.PHONY: uninstall
uninstall:
Zejun Lin's avatar
Zejun Lin committed
120
121
	-$(PIP_UNINSTALL) -y nni
	-$(PIP_UNINSTALL) -y nnictl
122
	-rm -rf $(NNI_PKG_FOLDER)
123
124
	-rm -f $(BIN_FOLDER)/node
	-rm -f $(BIN_FOLDER)/nnictl
liuzhe-lz's avatar
liuzhe-lz committed
125
126
	-rm -f $(BASH_COMP_SCRIPT)

QuanluZhang's avatar
QuanluZhang committed
127
128
129
130
131
132
133
134
135
136
137
.PHONY: clean
clean:
	-rm -rf tools/build
	-rm -rf tools/nnictl.egg-info
	-rm -rf src/nni_manager/dist
	-rm -rf src/nni_manager/node_modules
	-rm -rf src/sdk/pynni/build
	-rm -rf src/sdk/pynni/nni_sdk.egg-info
	-rm -rf src/webui/build
	-rm -rf src/webui/node_modules

liuzhe-lz's avatar
liuzhe-lz committed
138
139
140
141
# Main targets end

# Helper targets

Zejun Lin's avatar
Zejun Lin committed
142
$(NNI_NODE_TARBALL):
liuzhe-lz's avatar
liuzhe-lz committed
143
	#$(_INFO) Downloading Node.js $(_END)
144
	wget https://aka.ms/nni/nodejs-download/$(OS_SPEC) -O $(NNI_NODE_TARBALL)
liuzhe-lz's avatar
liuzhe-lz committed
145

Zejun Lin's avatar
Zejun Lin committed
146
$(NNI_YARN_TARBALL):
liuzhe-lz's avatar
liuzhe-lz committed
147
	#$(_INFO) Downloading Yarn $(_END)
148
	wget https://aka.ms/yarn-download -O $(NNI_YARN_TARBALL)
liuzhe-lz's avatar
liuzhe-lz committed
149

QuanluZhang's avatar
QuanluZhang committed
150
.PHONY: install-dependencies
Zejun Lin's avatar
Zejun Lin committed
151
install-dependencies: $(NNI_NODE_TARBALL) $(NNI_YARN_TARBALL)
liuzhe-lz's avatar
liuzhe-lz committed
152
	#$(_INFO) Extracting Node.js $(_END)
153
154
155
156
157
158
	rm -rf $(NNI_NODE_FOLDER)
	mkdir $(NNI_NODE_FOLDER)
	tar -xf $(NNI_NODE_TARBALL) -C $(NNI_NODE_FOLDER) --strip-components 1
	mkdir -p $(BIN_FOLDER)
	rm -f $(NNI_NODE)
	cp $(NNI_NODE_FOLDER)/bin/node $(NNI_NODE)
Deshui Yu's avatar
Deshui Yu committed
159
	
liuzhe-lz's avatar
liuzhe-lz committed
160
	#$(_INFO) Extracting Yarn $(_END)
161
162
163
	rm -rf $(NNI_YARN_FOLDER)
	mkdir $(NNI_YARN_FOLDER)
	tar -xf $(NNI_YARN_TARBALL) -C $(NNI_YARN_FOLDER) --strip-components 1
164

liuzhe-lz's avatar
liuzhe-lz committed
165
166
167
.PHONY: install-python-modules
install-python-modules:
	#$(_INFO) Installing Python SDK $(_END)
goooxu's avatar
goooxu committed
168
	cd src/sdk/pynni && sed -ie 's/$(NNI_VERSION_TEMPLATE)/$(NNI_VERSION_VALUE)/' setup.py && $(PIP_INSTALL) $(PIP_MODE) .
169
	
liuzhe-lz's avatar
liuzhe-lz committed
170
	#$(_INFO) Installing nnictl $(_END)
goooxu's avatar
goooxu committed
171
	cd tools && sed -ie 's/$(NNI_VERSION_TEMPLATE)/$(NNI_VERSION_VALUE)/' setup.py && $(PIP_INSTALL) $(PIP_MODE) .
172

Gems Guo's avatar
Gems Guo committed
173
174
175
.PHONY: dev-install-python-modules
dev-install-python-modules:
	#$(_INFO) Installing Python SDK $(_END)
goooxu's avatar
goooxu committed
176
	cd src/sdk/pynni && sed -ie 's/$(NNI_VERSION_TEMPLATE)/$(NNI_VERSION_VALUE)/' setup.py && $(PIP_INSTALL) $(PIP_MODE) -e .
Gems Guo's avatar
Gems Guo committed
177
178
	
	#$(_INFO) Installing nnictl $(_END)
goooxu's avatar
goooxu committed
179
	cd tools && sed -ie 's/$(NNI_VERSION_TEMPLATE)/$(NNI_VERSION_VALUE)/' setup.py && $(PIP_INSTALL) $(PIP_MODE) -e .
Gems Guo's avatar
Gems Guo committed
180

liuzhe-lz's avatar
liuzhe-lz committed
181
182
.PHONY: install-node-modules
install-node-modules:
183
	#$(_INFO) Installing NNI Package $(_END)
184
185
186
	rm -rf $(NNI_PKG_FOLDER)
	cp -r src/nni_manager/dist $(NNI_PKG_FOLDER)
	cp src/nni_manager/package.json $(NNI_PKG_FOLDER)
goooxu's avatar
goooxu committed
187
	sed -ie 's/$(NNI_VERSION_TEMPLATE)/$(NNI_VERSION_VALUE)/' $(NNI_PKG_FOLDER)/package.json
188
189
	$(NNI_YARN) --prod --cwd $(NNI_PKG_FOLDER)
	cp -r src/webui/build $(NNI_PKG_FOLDER)/static
Deshui Yu's avatar
Deshui Yu committed
190

Gems Guo's avatar
Gems Guo committed
191
192
.PHONY: dev-install-node-modules
dev-install-node-modules:
193
	#$(_INFO) Installing NNI Package $(_END)
194
195
	rm -rf $(NNI_PKG_FOLDER)
	ln -sf ${PWD}/src/nni_manager/dist $(NNI_PKG_FOLDER)
196
	cp src/nni_manager/package.json $(NNI_PKG_FOLDER)
goooxu's avatar
goooxu committed
197
	sed -ie 's/$(NNI_VERSION_TEMPLATE)/$(NNI_VERSION_VALUE)/' $(NNI_PKG_FOLDER)/package.json
198
199
	ln -sf ${PWD}/src/nni_manager/node_modules $(NNI_PKG_FOLDER)/node_modules
	ln -sf ${PWD}/src/webui/build $(NNI_PKG_FOLDER)/static
liuzhe-lz's avatar
liuzhe-lz committed
200
201
202

.PHONY: install-scripts
install-scripts:
203
204
	mkdir -p $(BASH_COMP_PREFIX)
	install -m644 tools/bash-completion $(BASH_COMP_SCRIPT)
Deshui Yu's avatar
Deshui Yu committed
205

liuzhe-lz's avatar
liuzhe-lz committed
206
207
208
209
.PHONY: update-bash-config
ifndef _ROOT
update-bash-config:
	#$(_INFO) Updating bash configurations $(_END)
210
211
212
    ifeq (, $(shell echo $$PATH | tr ':' '\n' | grep -x '$(BIN_FOLDER)'))  # $(BIN_FOLDER) not in PATH
	#$(_WARNING) NOTE: adding $(BIN_FOLDER) to PATH in bashrc $(_END)
	echo 'export PATH="$$PATH:$(BIN_FOLDER)"' >> ~/.bashrc
liuzhe-lz's avatar
liuzhe-lz committed
213
214
215
216
217
218
219
    endif
    ifeq (, $(shell (source ~/.bash_completion ; command -v _nnictl) 2>/dev/null))  # completion not installed
	#$(_WARNING) NOTE: adding $(BASH_COMP_SCRIPT) to ~/.bash_completion $(_END)
	echo '[[ -f $(BASH_COMP_SCRIPT) ]] && source $(BASH_COMP_SCRIPT)' >> ~/.bash_completion
    endif
else
update-bash-config: ;
liuzhe-lz's avatar
liuzhe-lz committed
220
221
222
223
224
225
226
227
228
229
230
231
232
endif

.PHONY: check-perm
ifdef _ROOT
check-perm:
	#$(_WARNING) Run easy-install as root is not optimal $(_END)
	#$(_WARNING) Suggest run as non-privileged user or manually install instead $(_END)
	#$(_WARNING) Continue easy-install as root? (y/N) $(_END)
	@read CONFIRM && [ "$$CONFIRM" = y ]
else
check-perm: ;
endif

Gems Guo's avatar
Gems Guo committed
233
.PHONY: dev-check-perm
liuzhe-lz's avatar
liuzhe-lz committed
234
ifdef _ROOT
Gems Guo's avatar
Gems Guo committed
235
dev-check-perm:
liuzhe-lz's avatar
liuzhe-lz committed
236
	$(error You should not develop NNI as root)
Gems Guo's avatar
Gems Guo committed
237
238
else
dev-check-perm: ;
liuzhe-lz's avatar
liuzhe-lz committed
239
240
241
endif

# Helper targets end