Add deprecation notices

ml-energy · Aug 23, 2023 · 82c59ee · 82c59ee
1 parent 4b20d31
commit 82c59ee
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/docs/getting_started/installing_and_building.md b/docs/getting_started/installing_and_building.md
@@ -1,6 +1,6 @@
 # Installing and Building Zeus Components
 
-This document explains how to install the [`zeus`][zeus] Python package and how to build the [Zeus power monitor](https://github.com/SymbioticLab/Zeus/tree/master/zeus_monitor).
+This document explains how to install the [`zeus`][zeus] Python package.
 
 !!! Tip
     We encourage users to utilize our Docker image. Please refer to [Environment setup](./environment.md). Quick command:
@@ -49,6 +49,10 @@ pip install -e .
 
 ## Zeus power monitor
 
+!!! Warning
+    The C++ Zeus power monitor is now deprecated as we've switched to a Python-based power monitor.
+    See [`PowerMonitor`][zeus.monitor.power.PowerMonitor] or run `python -m zeus.monitor --help`.
+
 ### Dependencies
 
 All dependencies are pre-installed if you're using our Docker image.  

diff --git a/examples/ZeusDataLoader/README.md b/examples/ZeusDataLoader/README.md
@@ -1,4 +1,4 @@
-# Examples for `ZeusDataLoader`
+# [Deprecated] Examples using `ZeusDataLoader`
 
 The `ZeusDataLoader` is on its way to deprecation, as we attempt to transition to new constructs including `ZeusMonitor`, `GlobalPowerLimitOptimizer`, and `EarlyStopController`.
 We'll keep these old examples around for while `ZeusDataLoader` still exists.
diff --git a/zeus_monitor/README.md b/zeus_monitor/README.md
@@ -1,4 +1,4 @@
-# Zeus Power Monitor
+# [Deprecated] Zeus Power Monitor
 
 This is a simple GPU power monitor used by Zeus.
 It polls NVML and writes outputs to the designated log file path.