Deployed 8430a42 with MkDocs version: 1.6.0

ml-energy · Aug 25, 2024 · b661108 · b661108
commit b661108
Show file tree

Hide file tree

Showing 226 changed files with 319,296 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/404.html b/404.html
diff --git a/assets/_mkdocstrings.css b/assets/_mkdocstrings.css
@@ -0,0 +1,119 @@
+
+/* Avoid breaking parameter names, etc. in table cells. */
+.doc-contents td code {
+  word-break: normal !important;
+}
+
+/* No line break before first paragraph of descriptions. */
+.doc-md-description,
+.doc-md-description>p:first-child {
+  display: inline;
+}
+
+/* Max width for docstring sections tables. */
+.doc .md-typeset__table,
+.doc .md-typeset__table table {
+  display: table !important;
+  width: 100%;
+}
+
+.doc .md-typeset__table tr {
+  display: table-row;
+}
+
+/* Defaults in Spacy table style. */
+.doc-param-default {
+  float: right;
+}
+
+/* Backward-compatibility: docstring section titles in bold. */
+.doc-section-title {
+  font-weight: bold;
+}
+
+/* Symbols in Navigation and ToC. */
+:root,
+[data-md-color-scheme="default"] {
+  --doc-symbol-attribute-fg-color: #953800;
+  --doc-symbol-function-fg-color: #8250df;
+  --doc-symbol-method-fg-color: #8250df;
+  --doc-symbol-class-fg-color: #0550ae;
+  --doc-symbol-module-fg-color: #5cad0f;
+
+  --doc-symbol-attribute-bg-color: #9538001a;
+  --doc-symbol-function-bg-color: #8250df1a;
+  --doc-symbol-method-bg-color: #8250df1a;
+  --doc-symbol-class-bg-color: #0550ae1a;
+  --doc-symbol-module-bg-color: #5cad0f1a;
+}
+
+[data-md-color-scheme="slate"] {
+  --doc-symbol-attribute-fg-color: #ffa657;
+  --doc-symbol-function-fg-color: #d2a8ff;
+  --doc-symbol-method-fg-color: #d2a8ff;
+  --doc-symbol-class-fg-color: #79c0ff;
+  --doc-symbol-module-fg-color: #baff79;
+
+  --doc-symbol-attribute-bg-color: #ffa6571a;
+  --doc-symbol-function-bg-color: #d2a8ff1a;
+  --doc-symbol-method-bg-color: #d2a8ff1a;
+  --doc-symbol-class-bg-color: #79c0ff1a;
+  --doc-symbol-module-bg-color: #baff791a;
+}
+
+code.doc-symbol {
+  border-radius: .1rem;
+  font-size: .85em;
+  padding: 0 .3em;
+  font-weight: bold;
+}
+
+code.doc-symbol-attribute {
+  color: var(--doc-symbol-attribute-fg-color);
+  background-color: var(--doc-symbol-attribute-bg-color);
+}
+
+code.doc-symbol-attribute::after {
+  content: "attr";
+}
+
+code.doc-symbol-function {
+  color: var(--doc-symbol-function-fg-color);
+  background-color: var(--doc-symbol-function-bg-color);
+}
+
+code.doc-symbol-function::after {
+  content: "func";
+}
+
+code.doc-symbol-method {
+  color: var(--doc-symbol-method-fg-color);
+  background-color: var(--doc-symbol-method-bg-color);
+}
+
+code.doc-symbol-method::after {
+  content: "meth";
+}
+
+code.doc-symbol-class {
+  color: var(--doc-symbol-class-fg-color);
+  background-color: var(--doc-symbol-class-bg-color);
+}
+
+code.doc-symbol-class::after {
+  content: "class";
+}
+
+code.doc-symbol-module {
+  color: var(--doc-symbol-module-fg-color);
+  background-color: var(--doc-symbol-module-bg-color);
+}
+
+code.doc-symbol-module::after {
+  content: "mod";
+}
+
+.doc-signature .autorefs {
+  color: inherit;
+  border-bottom: 1px dotted currentcolor;
+}
diff --git a/assets/css/color.css b/assets/css/color.css
@@ -0,0 +1,30 @@
+/*
+ * Zeus colors:
+ * - Black:   #231F20
+ * - Orange:  #e79613
+ * - Mustard: #ebbc00
+ * - Yellow:  #f7e96d
+ */
+
+[data-md-color-primary="zeus"] {
+  --md-primary-fg-color:        #ebbc00;
+  --md-primary-fg-color--light: #ebbc00;
+  --md-primary-fg-color--dark:  #ebbc00;
+  --md-primary-bg-color:        #231F20;
+  --md-primary-bg-color--light: #231F20;
+}
+
+[data-md-color-accent="zeus"] {
+  --md-accent-fg-color:              #f7e96d;
+  --md-accent-fg-color--transparent: #f7e96e30;
+  --md-accent-bg-color:              #231F20;
+  --md-accent-bg-color--light:       #231F20;
+}
+
+[data-md-color-scheme="default"] .critic-dark {
+  --md-typeset-mark-color: #00000015;
+}
+
+[data-md-color-scheme="slate"] .critic-dark {
+  --md-typeset-mark-color: #231F20;
+}
diff --git a/assets/css/custom.css b/assets/css/custom.css
@@ -0,0 +1,26 @@
+/* Indentation. */
+div.doc-contents:not(.first) {
+  padding-left: 25px;
+  border-left: .1rem solid var(--md-typeset-table-color);
+}
+
+/* Mark external links as such. */
+a.autorefs-external::after, a.external::after {
+  /* https://primer.style/octicons/arrow-up-right-24 */
+  background-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="rgb(0, 0, 0)" d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+  content: ' ';
+
+  display: inline-block;
+  position: relative;
+  top: 0.1em;
+  margin-left: 0.2em;
+  margin-right: 0.1em;
+
+  height: 1em;
+  width: 1em;
+  border-radius: 100%;
+  background-color: var(--md-typeset-a-color);
+}
+a.autorefs-external:hover::after, a.external:hover::after {
+  background-color: var(--md-accent-fg-color);
+}
diff --git a/assets/images/favicon.png b/assets/images/favicon.png
diff --git a/assets/img/favicon.svg b/assets/img/favicon.svg
diff --git a/assets/img/logo.svg b/assets/img/logo.svg
diff --git a/assets/img/logo_dark.svg b/assets/img/logo_dark.svg
diff --git a/assets/img/logo_light.svg b/assets/img/logo_light.svg
diff --git a/assets/img/og_image.png b/assets/img/og_image.png
diff --git a/assets/img/social/getting_started/index.png b/assets/img/social/getting_started/index.png
diff --git a/assets/img/social/index.png b/assets/img/social/index.png
diff --git a/assets/img/social/measure/index.png b/assets/img/social/measure/index.png
diff --git a/assets/img/social/optimize/batch_size_optimizer.png b/assets/img/social/optimize/batch_size_optimizer.png
diff --git a/assets/img/social/optimize/index.png b/assets/img/social/optimize/index.png
diff --git a/assets/img/social/optimize/pipeline_frequency_optimizer.png b/assets/img/social/optimize/pipeline_frequency_optimizer.png
diff --git a/assets/img/social/optimize/power_limit_optimizer.png b/assets/img/social/optimize/power_limit_optimizer.png
diff --git a/assets/img/social/reference/SUMMARY.png b/assets/img/social/reference/SUMMARY.png
diff --git a/assets/img/social/reference/_legacy/index.png b/assets/img/social/reference/_legacy/index.png
diff --git a/assets/img/social/reference/_legacy/job.png b/assets/img/social/reference/_legacy/job.png
diff --git a/assets/img/social/reference/_legacy/policy/index.png b/assets/img/social/reference/_legacy/policy/index.png
diff --git a/assets/img/social/reference/_legacy/policy/interface.png b/assets/img/social/reference/_legacy/policy/interface.png
diff --git a/assets/img/social/reference/_legacy/policy/mab.png b/assets/img/social/reference/_legacy/policy/mab.png
diff --git a/assets/img/social/reference/_legacy/policy/optimizer.png b/assets/img/social/reference/_legacy/policy/optimizer.png
diff --git a/assets/img/social/reference/_legacy/simulate.png b/assets/img/social/reference/_legacy/simulate.png
diff --git a/assets/img/social/reference/callback.png b/assets/img/social/reference/callback.png
diff --git a/assets/img/social/reference/device/common.png b/assets/img/social/reference/device/common.png
diff --git a/assets/img/social/reference/device/cpu/common.png b/assets/img/social/reference/device/cpu/common.png
diff --git a/assets/img/social/reference/device/cpu/index.png b/assets/img/social/reference/device/cpu/index.png
diff --git a/assets/img/social/reference/device/cpu/rapl.png b/assets/img/social/reference/device/cpu/rapl.png
diff --git a/assets/img/social/reference/device/exception.png b/assets/img/social/reference/device/exception.png
diff --git a/assets/img/social/reference/device/gpu/amd.png b/assets/img/social/reference/device/gpu/amd.png
diff --git a/assets/img/social/reference/device/gpu/common.png b/assets/img/social/reference/device/gpu/common.png
diff --git a/assets/img/social/reference/device/gpu/index.png b/assets/img/social/reference/device/gpu/index.png
diff --git a/assets/img/social/reference/device/gpu/nvidia.png b/assets/img/social/reference/device/gpu/nvidia.png
diff --git a/assets/img/social/reference/device/index.png b/assets/img/social/reference/device/index.png
diff --git a/assets/img/social/reference/exception.png b/assets/img/social/reference/exception.png
diff --git a/assets/img/social/reference/index.png b/assets/img/social/reference/index.png
diff --git a/assets/img/social/reference/monitor/energy.png b/assets/img/social/reference/monitor/energy.png
diff --git a/assets/img/social/reference/monitor/index.png b/assets/img/social/reference/monitor/index.png
diff --git a/assets/img/social/reference/monitor/power.png b/assets/img/social/reference/monitor/power.png
diff --git a/assets/img/social/reference/optimizer/batch_size/client.png b/assets/img/social/reference/optimizer/batch_size/client.png
diff --git a/assets/img/social/reference/optimizer/batch_size/common.png b/assets/img/social/reference/optimizer/batch_size/common.png
diff --git a/assets/img/social/reference/optimizer/batch_size/exceptions.png b/assets/img/social/reference/optimizer/batch_size/exceptions.png
diff --git a/assets/img/social/reference/optimizer/batch_size/index.png b/assets/img/social/reference/optimizer/batch_size/index.png
diff --git a/.../img/social/reference/optimizer/batch_size/server/batch_size_state/commands.png b/.../img/social/reference/optimizer/batch_size/server/batch_size_state/commands.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/batch_size_state/index.png b/assets/img/social/reference/optimizer/batch_size/server/batch_size_state/index.png
diff --git a/...ts/img/social/reference/optimizer/batch_size/server/batch_size_state/models.png b/...ts/img/social/reference/optimizer/batch_size/server/batch_size_state/models.png
diff --git a/...mg/social/reference/optimizer/batch_size/server/batch_size_state/repository.png b/...mg/social/reference/optimizer/batch_size/server/batch_size_state/repository.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/config.png b/assets/img/social/reference/optimizer/batch_size/server/config.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/database/db_connection.png b/assets/img/social/reference/optimizer/batch_size/server/database/db_connection.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/database/index.png b/assets/img/social/reference/optimizer/batch_size/server/database/index.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/database/repository.png b/assets/img/social/reference/optimizer/batch_size/server/database/repository.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/database/schema.png b/assets/img/social/reference/optimizer/batch_size/server/database/schema.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/exceptions.png b/assets/img/social/reference/optimizer/batch_size/server/exceptions.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/explorer.png b/assets/img/social/reference/optimizer/batch_size/server/explorer.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/index.png b/assets/img/social/reference/optimizer/batch_size/server/index.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/job/commands.png b/assets/img/social/reference/optimizer/batch_size/server/job/commands.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/job/index.png b/assets/img/social/reference/optimizer/batch_size/server/job/index.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/job/models.png b/assets/img/social/reference/optimizer/batch_size/server/job/models.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/job/repository.png b/assets/img/social/reference/optimizer/batch_size/server/job/repository.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/mab.png b/assets/img/social/reference/optimizer/batch_size/server/mab.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/optimizer.png b/assets/img/social/reference/optimizer/batch_size/server/optimizer.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/router.png b/assets/img/social/reference/optimizer/batch_size/server/router.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/services/commands.png b/assets/img/social/reference/optimizer/batch_size/server/services/commands.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/services/index.png b/assets/img/social/reference/optimizer/batch_size/server/services/index.png
diff --git a/assets/img/social/reference/optimizer/batch_size/server/services/service.png b/assets/img/social/reference/optimizer/batch_size/server/services/service.png
diff --git a/assets/img/social/reference/optimizer/index.png b/assets/img/social/reference/optimizer/index.png
diff --git a/assets/img/social/reference/optimizer/pipeline_frequency/common.png b/assets/img/social/reference/optimizer/pipeline_frequency/common.png
diff --git a/assets/img/social/reference/optimizer/pipeline_frequency/frequency_controller.png b/assets/img/social/reference/optimizer/pipeline_frequency/frequency_controller.png
diff --git a/assets/img/social/reference/optimizer/pipeline_frequency/index.png b/assets/img/social/reference/optimizer/pipeline_frequency/index.png
diff --git a/assets/img/social/reference/optimizer/pipeline_frequency/optimizer.png b/assets/img/social/reference/optimizer/pipeline_frequency/optimizer.png
diff --git a/assets/img/social/reference/optimizer/pipeline_frequency/server/index.png b/assets/img/social/reference/optimizer/pipeline_frequency/server/index.png
diff --git a/assets/img/social/reference/optimizer/pipeline_frequency/server/job_manager.png b/assets/img/social/reference/optimizer/pipeline_frequency/server/job_manager.png
diff --git a/assets/img/social/reference/optimizer/pipeline_frequency/server/router.png b/assets/img/social/reference/optimizer/pipeline_frequency/server/router.png
diff --git a/assets/img/social/reference/optimizer/pipeline_frequency/server/scheduler.png b/assets/img/social/reference/optimizer/pipeline_frequency/server/scheduler.png
diff --git a/assets/img/social/reference/optimizer/power_limit.png b/assets/img/social/reference/optimizer/power_limit.png
diff --git a/assets/img/social/reference/utils/async_utils.png b/assets/img/social/reference/utils/async_utils.png
diff --git a/assets/img/social/reference/utils/env.png b/assets/img/social/reference/utils/env.png
diff --git a/assets/img/social/reference/utils/framework.png b/assets/img/social/reference/utils/framework.png
diff --git a/assets/img/social/reference/utils/index.png b/assets/img/social/reference/utils/index.png
diff --git a/assets/img/social/reference/utils/logging.png b/assets/img/social/reference/utils/logging.png
diff --git a/assets/img/social/reference/utils/lr_scaler.png b/assets/img/social/reference/utils/lr_scaler.png
diff --git a/assets/img/social/reference/utils/metric.png b/assets/img/social/reference/utils/metric.png
diff --git a/assets/img/social/reference/utils/pydantic_v1.png b/assets/img/social/reference/utils/pydantic_v1.png
diff --git a/assets/img/social/reference/utils/testing.png b/assets/img/social/reference/utils/testing.png
diff --git a/assets/img/social/research_overview/index.png b/assets/img/social/research_overview/index.png
diff --git a/assets/img/social/research_overview/perseus.png b/assets/img/social/research_overview/perseus.png
diff --git a/assets/img/social/research_overview/zeus.png b/assets/img/social/research_overview/zeus.png