Remove copyright notices in source code, add scripts/preview_docs.sh

capriccio/generate.py

@@ -1,19 +1,4 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""
-Generate the Capriccio dataset.
+"""Generate the Capriccio dataset.
 
 This script takes as input the path to the Sentiment140 dataset
 and slices it into 38 overlapping slices. Each slice has 425000

docker/Dockerfile

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-# 
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-# 
-#     http://www.apache.org/licenses/LICENSE-2.0
-# 
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # Build instructions
 #   If you're building this image locally, make sure you specify `TARGETARCH`.
 #   Currently, this image supports `amd64` and `arm64`. For instance:

docs/gen_ref_pages.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """Generate source code references pages."""
 
 from pathlib import Path

examples/pipeline_frequency_optimizer/run_optimization.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """Example script of running pipeline frequency optimization."""
 
 from __future__ import annotations

examples/research_reproducibility/zeus_nsdi23/run_alibaba.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """Example script for running the Zeus trace-driven simulator."""
 
 from __future__ import annotations

examples/research_reproducibility/zeus_nsdi23/run_single.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """Example script for running the Zeus trace-driven simulator."""
 
 from __future__ import annotations

pyproject.toml

@@ -7,7 +7,7 @@ name = "zeus-ml"
 description = "A framework for deep learning energy measurement and optimization."
 readme = "README.md"
 authors = [
-    {name = "Jae-Won Chung", email = "[email protected]"},
+    {name = "Zeus Team"},
 ]
 license = {text = "Apache 2.0"}
 classifiers = [
@@ -16,8 +16,10 @@ classifiers = [
     "Topic :: Scientific/Engineering :: Artificial Intelligence",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
 ]
-keywords = ["deep-learning", "power", "energy", "sustainability", "mlsys"]
+keywords = ["deep-learning", "power", "energy", "carbon", "sustainability", "mlsys"]
 requires-python = ">=3.9"
 dependencies = [
     "numpy",

scripts/preview_docs.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+pip list | grep mkdocs-material 2>&1 >/dev/null
+
+if [[ ! $? -eq 0 ]]; then
+  echo "Run the following to install documentation build dependnecies:"
+  echo "    pip install '.[docs]'"
+  exit 1
+fi
+
+mkdocs serve -a localhost:7777 -w zeus --strict

tests/optimizer/batch_size/simulate_with_server.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """A simulator for running trace-driven Zeus experiments."""
 
 from __future__ import annotations

tests/optimizer/test_power_limit_optimizer.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 from __future__ import annotations
 
 import inspect

tests/test_monitor.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 from __future__ import annotations
 
 import itertools

tests/utils/test_env.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 from __future__ import annotations
 
 import os

zeus/__init__.py

@@ -1,25 +1,12 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """Zeus is a framework for deep learning energy measurement and optimization.
 
-- [`optimizer`][zeus.optimizer]: A collection of optimizers for time and energy
-- [`monitor`][zeus.monitor]: Programmatic power and energy measurement tools
-- [`utils`][zeus.utils]: Utility functions and classes.
-- [`_legacy`][zeus._legacy.policy]: Legacy code mostly to keep our papers reproducible
 - [`device`][zeus.device]: Abstraction layer over compute devices
+- [`monitor`][zeus.monitor]: Programmatic power and energy measurement tools
+- [`optimizer`][zeus.optimizer]: A collection of optimizers for time and energy
+- [`utils`][zeus.utils]: Utility functions and classes
 - [`callback`][zeus.callback]: Callback definition
+- [`exception`][zeus.exception]: Base exception class definition
+- [`_legacy`][zeus._legacy.policy]: Legacy code mostly to keep our papers reproducible
 """
 
 __version__ = "0.9.1"

zeus/_legacy/job.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """Defines the Job specification dataclass."""
 
 from __future__ import annotations

zeus/_legacy/policy/__init__.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """Optimization policies for Zeus.
 
 [`PowerLimitOptimizer`][zeus._legacy.policy.interface.PowerLimitOptimizer] and

zeus/_legacy/policy/interface.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """Abstract classes for implementing custom optimization policies."""
 
 from __future__ import annotations

zeus/_legacy/policy/mab.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """Multi-Armed Bandit implementations."""
 
 from __future__ import annotations

zeus/_legacy/policy/optimizer.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """Implementations of various optimization policies.
 
 [`JITPowerLimitOptimizer`][zeus._legacy.policy.optimizer.JITPowerLimitOptimizer] and

zeus/_legacy/simulate.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """A simulator for running trace-driven Zeus experiments."""
 
 from __future__ import annotations

zeus/callback.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """Infrastructure for calling callbacks."""
 
 from __future__ import annotations

zeus/monitor/__init__.py

@@ -1,17 +1,3 @@
-# Copyright (C) 2023 Jae-Won Chung <[email protected]>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 """Time, energy, and power monitors for Zeus.
 
 The main class of this module is [`ZeusMonitor`][zeus.monitor.energy.ZeusMonitor].