Merge branch 'main' into server_release_process_doc

wandb · Dec 27, 2023 · b3617a5 · b3617a5
2 parents 0fff325 + 417b3d2
commit b3617a5
Show file tree

Hide file tree

Showing 47 changed files with 116 additions and 10 deletions.
diff --git a/styles/Google/AMPM.yml → .github/styles/Google/AMPM.yml b/styles/Google/AMPM.yml → .github/styles/Google/AMPM.yml
diff --git a/styles/Google/Acronyms.yml → .github/styles/Google/Acronyms.yml b/styles/Google/Acronyms.yml → .github/styles/Google/Acronyms.yml
diff --git a/styles/Google/Colons.yml → .github/styles/Google/Colons.yml b/styles/Google/Colons.yml → .github/styles/Google/Colons.yml
diff --git a/styles/Google/Contractions.yml → .github/styles/Google/Contractions.yml b/styles/Google/Contractions.yml → .github/styles/Google/Contractions.yml
@@ -27,4 +27,4 @@ swap:
   what is: what's
   when is: when's
   where is: where's
-  will not: won't
+  will not: won't
diff --git a/styles/Google/DateFormat.yml → .github/styles/Google/DateFormat.yml b/styles/Google/DateFormat.yml → .github/styles/Google/DateFormat.yml
diff --git a/styles/Google/Ellipses.yml → .github/styles/Google/Ellipses.yml b/styles/Google/Ellipses.yml → .github/styles/Google/Ellipses.yml
diff --git a/styles/Google/EmDash.yml → .github/styles/Google/EmDash.yml b/styles/Google/EmDash.yml → .github/styles/Google/EmDash.yml
diff --git a/styles/Google/EnDash.yml → .github/styles/Google/EnDash.yml b/styles/Google/EnDash.yml → .github/styles/Google/EnDash.yml
diff --git a/styles/Google/Exclamation.yml → .github/styles/Google/Exclamation.yml b/styles/Google/Exclamation.yml → .github/styles/Google/Exclamation.yml
diff --git a/styles/Google/FirstPerson.yml → .github/styles/Google/FirstPerson.yml b/styles/Google/FirstPerson.yml → .github/styles/Google/FirstPerson.yml
diff --git a/styles/Google/Gender.yml → .github/styles/Google/Gender.yml b/styles/Google/Gender.yml → .github/styles/Google/Gender.yml
diff --git a/styles/Google/GenderBias.yml → .github/styles/Google/GenderBias.yml b/styles/Google/GenderBias.yml → .github/styles/Google/GenderBias.yml
diff --git a/styles/Google/HeadingPunctuation.yml → .github/styles/Google/HeadingPunctuation.yml b/styles/Google/HeadingPunctuation.yml → .github/styles/Google/HeadingPunctuation.yml
diff --git a/styles/Google/Headings.yml → .github/styles/Google/Headings.yml b/styles/Google/Headings.yml → .github/styles/Google/Headings.yml
diff --git a/styles/Google/Latin.yml → .github/styles/Google/Latin.yml b/styles/Google/Latin.yml → .github/styles/Google/Latin.yml
diff --git a/styles/Google/LyHyphens.yml → .github/styles/Google/LyHyphens.yml b/styles/Google/LyHyphens.yml → .github/styles/Google/LyHyphens.yml
diff --git a/styles/Google/OptionalPlurals.yml → .github/styles/Google/OptionalPlurals.yml b/styles/Google/OptionalPlurals.yml → .github/styles/Google/OptionalPlurals.yml
diff --git a/styles/Google/Ordinal.yml → .github/styles/Google/Ordinal.yml b/styles/Google/Ordinal.yml → .github/styles/Google/Ordinal.yml
diff --git a/styles/Google/OxfordComma.yml → .github/styles/Google/OxfordComma.yml b/styles/Google/OxfordComma.yml → .github/styles/Google/OxfordComma.yml
diff --git a/styles/Google/Parens.yml → .github/styles/Google/Parens.yml b/styles/Google/Parens.yml → .github/styles/Google/Parens.yml
diff --git a/styles/Google/Passive.yml → .github/styles/Google/Passive.yml b/styles/Google/Passive.yml → .github/styles/Google/Passive.yml
diff --git a/styles/Google/Periods.yml → .github/styles/Google/Periods.yml b/styles/Google/Periods.yml → .github/styles/Google/Periods.yml
diff --git a/styles/Google/Quotes.yml → .github/styles/Google/Quotes.yml b/styles/Google/Quotes.yml → .github/styles/Google/Quotes.yml
diff --git a/styles/Google/Ranges.yml → .github/styles/Google/Ranges.yml b/styles/Google/Ranges.yml → .github/styles/Google/Ranges.yml
diff --git a/styles/Google/Semicolons.yml → .github/styles/Google/Semicolons.yml b/styles/Google/Semicolons.yml → .github/styles/Google/Semicolons.yml
diff --git a/styles/Google/Slang.yml → .github/styles/Google/Slang.yml b/styles/Google/Slang.yml → .github/styles/Google/Slang.yml
diff --git a/styles/Google/Spacing.yml → .github/styles/Google/Spacing.yml b/styles/Google/Spacing.yml → .github/styles/Google/Spacing.yml
diff --git a/styles/Google/Spelling.yml → .github/styles/Google/Spelling.yml b/styles/Google/Spelling.yml → .github/styles/Google/Spelling.yml
diff --git a/styles/Google/Units.yml → .github/styles/Google/Units.yml b/styles/Google/Units.yml → .github/styles/Google/Units.yml
diff --git a/styles/Google/We.yml → .github/styles/Google/We.yml b/styles/Google/We.yml → .github/styles/Google/We.yml
diff --git a/styles/Google/Will.yml → .github/styles/Google/Will.yml b/styles/Google/Will.yml → .github/styles/Google/Will.yml
diff --git a/styles/Google/WordList.yml → .github/styles/Google/WordList.yml b/styles/Google/WordList.yml → .github/styles/Google/WordList.yml
diff --git a/styles/Google/meta.json → .github/styles/Google/meta.json b/styles/Google/meta.json → .github/styles/Google/meta.json
diff --git a/styles/Google/vocab.txt → .github/styles/Google/vocab.txt b/styles/Google/vocab.txt → .github/styles/Google/vocab.txt
diff --git a/styles/Readability/AutomatedReadability.yml → ...yles/Readability/AutomatedReadability.yml b/styles/Readability/AutomatedReadability.yml → ...yles/Readability/AutomatedReadability.yml
diff --git a/styles/Readability/ColemanLiau.yml → .github/styles/Readability/ColemanLiau.yml b/styles/Readability/ColemanLiau.yml → .github/styles/Readability/ColemanLiau.yml
diff --git a/styles/Readability/FleschKincaid.yml → .github/styles/Readability/FleschKincaid.yml b/styles/Readability/FleschKincaid.yml → .github/styles/Readability/FleschKincaid.yml
diff --git a/styles/Readability/FleschReadingEase.yml → .../styles/Readability/FleschReadingEase.yml b/styles/Readability/FleschReadingEase.yml → .../styles/Readability/FleschReadingEase.yml
diff --git a/styles/Readability/GunningFog.yml → .github/styles/Readability/GunningFog.yml b/styles/Readability/GunningFog.yml → .github/styles/Readability/GunningFog.yml
diff --git a/styles/Readability/LIX.yml → .github/styles/Readability/LIX.yml b/styles/Readability/LIX.yml → .github/styles/Readability/LIX.yml
diff --git a/styles/Readability/SMOG.yml → .github/styles/Readability/SMOG.yml b/styles/Readability/SMOG.yml → .github/styles/Readability/SMOG.yml
diff --git a/styles/Readability/meta.json → .github/styles/Readability/meta.json b/styles/Readability/meta.json → .github/styles/Readability/meta.json
diff --git a/styles/Vocab/Docs/accept.txt → .github/styles/Vocab/Docs/accept.txt b/styles/Vocab/Docs/accept.txt → .github/styles/Vocab/Docs/accept.txt
@@ -1,16 +1,22 @@
-CLI
 Autogenerate
+[Cc]heckpointing
+CLI
 Colab
 [Cc]onfig
+CTAButtons
+[Dd]ataframe
 [Dd]equeue
 [Dd]equeues
 Dockerfile
 [Ee]nqueued
+GPUs
+[Hh]ostname
 [Hh]yperparameters
 [Hh]yperparameter
-GPUs
 Kaniko
 Kubeflow
 [Nn]amespace
 Optuna
-[Ww]alkthrough
+[Pp]seudocode
+[Ww]alkthrough
+W&B Server
diff --git a/.github/styles/Vocab/Docs/reject.txt b/.github/styles/Vocab/Docs/reject.txt
@@ -0,0 +1 @@
+wandb
diff --git a/.github/workflows/reviewdog.yml b/.github/workflows/reviewdog.yml
@@ -0,0 +1,10 @@
+name: reviewdog
+on: [pull_request]
+
+jobs:
+  vale:
+    name: runner / vale
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: errata-ai/vale-action@reviewdog
diff --git a/.vale.ini b/.vale.ini
@@ -1,15 +1,24 @@
 # Specifies where Vale should look for its external resources (e.g., styles)
-StylesPath = styles
+StylesPath = .github/styles
 
 # Specifies the minimum alert severity that Vale will report.
 MinAlertLevel = suggestion
 
+# By default, `code` and `tt` are ignored.
+IgnoredScopes = code, tt
+
+# To do: Remove CTAButtons from accept.txt
+
+# By default, `script`, `style`, `pre`, and `figure` are ignored.
+SkippedScopes = script, style, pre, figure
+
 # Folder in ./styles where we specify terms that we accept and reject.
 Vocab=Docs
 
 Packages = Google, Readability
 
 ## Format-specific settings
 [*.md]
-BasedOnStyles = Vale, Google, Readability
+BasedOnStyles = Vale, Google
 
+Google.Contractions = No
diff --git a/docs/guides/sweeps/define-sweep-configuration.md b/docs/guides/sweeps/define-sweep-configuration.md
@@ -229,12 +229,19 @@ Describe the hyperparameters to explore during the sweep. For each hyperparamete
   <TabItem value="nested">
 
   ```yaml
-  optimizer:
-      parameters:
+  top_level_param:
+    min: 0
+    max: 5
+  nested_param:
+      parameters:  # required key
           learning_rate:
               values: [0.01, 0.001]
-          momentum:
-              value: 0.9
+          double_nested_param:
+            parameters:  # <--
+              x:
+                value: 0.9
+              y: 
+                value: 0.8
   ```
 
   </TabItem>
@@ -582,3 +589,76 @@ command:
 ```
   </TabItem>
 </Tabs>
+
+### Nested Parameters
+
+The sweep configuration format supports specifying nested parameters. To delineate a nested parameter, use an additional `parameters` key under the top level parameter name. Multi-level nesting is allowed. For a complete sweep configuration example: 
+
+```yaml
+program: train.py
+method: bayes
+metric:
+  name: val_loss
+  goal: minimize
+top_level_param:
+  min: 0
+  max: 5
+nested_param:
+  parameters:  # required key
+    learning_rate:
+      values: [0.01, 0.001]
+    double_nested_param:
+      parameters:  # <--
+        x:
+          value: 0.9
+        y: 
+          value: 0.8
+```
+
+The above configuration might result in the following run config (in `train.py`):
+
+```json
+{
+  "top_level_param": 0,
+  "nested_param": {
+    "learning_rate": 0.01,
+    "double_nested_param": {
+      "x": 0.9,
+      "y": 0.8
+    }
+  }
+}
+```
+
+:::caution
+Nested parameters overwrite keys specified in a run configuration.
+
+For example, suppose you initialize a W&B run with the following configuration:
+
+```python
+run = wandb.init(config = {
+  "nested_param": { 
+    "manual_key": 1
+    }
+  }
+)
+```
+
+If you then create a sweep with the following sweep configuration:
+
+```json
+{
+  "top_level_param": 0,
+  "nested_param": {
+    "learning_rate": 0.01,
+    "double_nested_param": {
+      "x": 0.9,
+      "y": 0.8
+    }
+  }
+}
+```
+
+The `nested_param.manual_key` that was passed when the W&B run was initialized will not be available. Instead, the `run.config` will look exactly like the JSON code snippet shown above.
+:::
+