Merge branch 'main' into add-csv-export

iterative · Jul 13, 2023 · 6e9158d · 6e9158d
2 parents d40b159 + 2742dce
commit 6e9158d
Show file tree

Hide file tree

Showing 33 changed files with 1,558 additions and 930 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,28 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.0.17] - 2023-07-11
+
+### 🚀 New Features and Enhancements
+
+- Apply product feedback to dvc.yaml snippets [#4255](https://github.com/iterative/vscode-dvc/pull/4255) by [@mattseddon](https://github.com/mattseddon)
+- Add DVCLive snippets [#4258](https://github.com/iterative/vscode-dvc/pull/4258) by [@mattseddon](https://github.com/mattseddon)
+
+### 🔨 Maintenance
+
+- Update demo project and latest tested CLI version (3.5.1) [#4257](https://github.com/iterative/vscode-dvc/pull/4257) by [@mattseddon](https://github.com/mattseddon)
+
+## [1.0.16] - 2023-07-11
+
+### 🚀 New Features and Enhancements
+
+- Display DAG in Markdown Preview editor [#4244](https://github.com/iterative/vscode-dvc/pull/4244) by [@mattseddon](https://github.com/mattseddon)
+
+### 🔨 Maintenance
+
+- Correct extension reference in snippet [#4245](https://github.com/iterative/vscode-dvc/pull/4245) by [@mattseddon](https://github.com/mattseddon)
+- Update demo project and latest tested CLI version (3.5.0) [#4251](https://github.com/iterative/vscode-dvc/pull/4251) by [@mattseddon](https://github.com/mattseddon)
+
 ## [1.0.15] - 2023-07-09
 
 ### 🚀 New Features and Enhancements

diff --git a/README.md b/README.md
@@ -143,17 +143,18 @@ These are the VS Code [settings] available for the Extension:
 
 [settings]: https://code.visualstudio.com/docs/getstarted/settings
 
-| **Option**                             | **Description**                                                                                                                                          |
-| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `dvc.dvcPath`                          | Path or shell command to the DVC binary. Required unless Microsoft's [Python extension] is installed and the `dvc` package found in its environment.     |
-| `dvc.pythonPath`                       | Path to the desired Python interpreter to use with DVC. Should only be utilized when using a virtual environment without Microsoft's [Python extension]. |
-| `dvc.experimentsTableHeadMaxHeight`    | Maximum height of experiment table head rows.                                                                                                            |
-| `dvc.focusedProjects`                  | A subset of paths to the workspace's available DVC projects. Using this option will override project auto-discovery.                                     |
-| `dvc.doNotInformMaxExperimentsPlotted` | Do not inform when plotting more experiments is blocked (maximum number selected).                                                                       |
-| `dvc.doNotShowSetupAfterInstall`       | Do not prompt to show the setup page after installing. Useful for pre-configured development environments.                                               |
-| `dvc.doNotRecommendAddStudioToken`     | Do not prompt to add a [studio.token] to the global DVC config, which enables automatic sharing of experiments to [Studio].                              |
-| `dvc.doNotRecommendRedHatExtension`    | Do not prompt to install the Red Hat YAML extension, which helps with DVC YAML schema validation (`dvc.yaml` and `.dvc` files).                          |
-| `dvc.doNotShowCliUnavailable`          | Do not warn when the workspace contains a DVC project but the DVC binary is unavailable.                                                                 |
+| **Option**                                  | **Description**                                                                                                                                          |
+| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `dvc.dvcPath`                               | Path or shell command to the DVC binary. Required unless Microsoft's [Python extension] is installed and the `dvc` package found in its environment.     |
+| `dvc.pythonPath`                            | Path to the desired Python interpreter to use with DVC. Should only be utilized when using a virtual environment without Microsoft's [Python extension]. |
+| `dvc.experimentsTableHeadMaxHeight`         | Maximum height of experiment table head rows.                                                                                                            |
+| `dvc.focusedProjects`                       | A subset of paths to the workspace's available DVC projects. Using this option will override project auto-discovery.                                     |
+| `dvc.doNotInformMaxExperimentsPlotted`      | Do not inform when plotting more experiments is blocked (maximum number selected).                                                                       |
+| `dvc.doNotShowSetupAfterInstall`            | Do not prompt to show the setup page after installing. Useful for pre-configured development environments.                                               |
+| `dvc.doNotRecommendAddStudioToken`          | Do not prompt to add a [studio.token] to the global DVC config, which enables automatic sharing of experiments to [Studio].                              |
+| `dvc.doNotRecommendRedHatExtension`         | Do not prompt to install the Red Hat YAML extension, which helps with DVC YAML schema validation (`dvc.yaml` and `.dvc` files).                          |
+| `dvc.doNotRecommendMermaidSupportExtension` | Do not prompt to install the Markdown Preview Mermaid Support extension, which helps to visualize DVC pipeline DAGs.                                     |
+| `dvc.doNotShowCliUnavailable`               | Do not warn when the workspace contains a DVC project but the DVC binary is unavailable.                                                                 |
 
 > **Note** that the `Setup The Workspace` command helps you set up the basic
 > ones at the [Workspace level] (saved to `.vscode/setting.json`).

diff --git a/demo b/demo
diff --git a/extension/package.json b/extension/package.json
@@ -9,7 +9,7 @@
   "extensionDependencies": [
     "vscode.git"
   ],
-  "version": "1.0.15",
+  "version": "1.0.17",
   "license": "Apache-2.0",
   "readme": "./README.md",
   "repository": {
@@ -417,6 +417,11 @@
         "command": "dvc.showOutput",
         "category": "DVC"
       },
+      {
+        "title": "Show Pipeline DAG",
+        "command": "dvc.showPipelineDAG",
+        "category": "DVC"
+      },
       {
         "title": "Show Plots",
         "command": "dvc.showPlots",
@@ -606,6 +611,11 @@
           "type": "boolean",
           "default": null
         },
+        "dvc.doNotRecommendMermaidSupportExtension": {
+          "description": "Do not prompt to install the Markdown Preview Mermaid Support extension, which helps to visualize DVC pipeline DAGs",
+          "type": "boolean",
+          "default": null
+        },
         "dvc.doNotRecommendAddStudioToken": {
           "description": "Do not prompt to add a studio.token to the global DVC config, which enables automatic sharing of experiments to Studio.",
           "type": "boolean",
@@ -876,6 +886,10 @@
           "command": "dvc.showCommands",
           "when": "false"
         },
+        {
+          "command": "dvc.showPipelineDAG",
+          "when": "dvc.commands.available && dvc.project.available"
+        },
         {
           "command": "dvc.showExperiments",
           "when": "dvc.commands.available && dvc.project.available"
@@ -1385,6 +1399,10 @@
       {
         "language": "yaml",
         "path": "./snippets/dvc-yaml.code-snippets"
+      },
+      {
+        "language": "python",
+        "path": "./snippets/dvclive.code-snippets"
       }
     ],
     "viewsContainers": {
@@ -1646,7 +1664,7 @@
   },
   "dependencies": {
     "@hediet/std": "0.6.0",
-    "@vscode/extension-telemetry": "0.8.0",
+    "@vscode/extension-telemetry": "0.8.1",
     "appdirs": "1.1.0",
     "execa": "5.1.1",
     "fs-extra": "11.1.1",
@@ -1666,7 +1684,7 @@
     "vscode-languageclient": "8.1.0"
   },
   "devDependencies": {
-    "@swc/core": "1.3.67",
+    "@swc/core": "1.3.68",
     "@swc/jest": "0.2.26",
     "@types/chai": "4.3.5",
     "@types/chai-as-promised": "7.1.5",
@@ -1699,8 +1717,8 @@
     "clean-webpack-plugin": "4.0.0",
     "copy-webpack-plugin": "11.0.0",
     "fork-ts-checker-webpack-plugin": "8.0.0",
-    "jest": "29.5.0",
-    "jest-environment-node": "29.5.0",
+    "jest": "29.6.0",
+    "jest-environment-node": "29.6.0",
     "lint-staged": "13.2.3",
     "mocha": "10.2.0",
     "mock-require": "3.0.3",

diff --git a/extension/snippets/dvc-yaml.code-snippets b/extension/snippets/dvc-yaml.code-snippets
@@ -13,123 +13,110 @@
   "Pipeline Stage Template": {
     "prefix": "dvc-pipeline-stage",
     "body": [
-      "  ${1:stage name}:",
-      "    cmd: ${2:command for the stage, e.g. python train.py}",
+      "  ${1:train}:",
+      "    cmd: ${2:python train.py}",
       "    deps:",
-      "      - ${3:list dependencies for the stage, e.g. train.py}",
+      "      - ${3:train.py}",
       "    params:",
-      "      - ${4:list params file(s) for the stage, e.g params.yaml}",
-      "    metrics:",
-      "      - ${5:list metric file(s) for the stage, e.g metrics.json}",
+      "      - ${4:params.yaml:}",
       "    outs:",
-      "      - ${6:list output(s) of the stage, e.g. model.pkl}"
+      "      - ${5:model.pkl}"
     ],
     "description": "Stage template for dvc.yaml pipeline"
   },
-  "Minimal Pipeline Stage Template": {
-    "prefix": "dvc-pipeline-minimal-stage",
-    "body": [
-      "  ${1:stage name}:",
-      "    cmd: ${2:command for the stage, e.g. python train.py}",
-      "    deps:",
-      "      - ${3:list dependencies for the stage, e.g. train.py}",
-      "    outs:",
-      "      - ${4:list output(s) of the stage, e.g. model.pkl}"
-    ],
-    "description": "Minimal stage template for dvc.yaml pipeline"
-  },
   "Foreach Pipeline Stage Template": {
     "prefix": "dvc-pipeline-foreach-stage",
     "body": [
-      "  ${1:stage name}:",
+      "  ${1:cleanups}:",
       "    foreach:",
-      "      - ${2:list of simple values to iterate over}",
+      "      - ${2:raw1}",
+      "      - ${3:raw2}",
       "    do:",
-      "      cmd: ${3:command to be run for each templated item, e.g python evaluate.py} \"\\${item}\"",
+      "      cmd: ${4:python clean.py} \"\\${item}\"",
       "      outs:",
-      "      - \\${item}.${5:suffix for the templated output file, e.g. pkl}"
+      "      - \\${item}.${5:cln}"
     ],
     "description": "Foreach stage template for dvc.yaml pipeline"
   },
   "Single File Plot Template": {
     "prefix": "dvc-plot-single",
     "body": [
-      "  - ${1:file, e.g. probs.json}:",
+      "  - ${1:probs.json}:",
       "      template: ${2|linear,simple,scatter,smooth,confusion,confusion_normalized,bar_horizontal,bar_horizontal_sorted|}",
-      "      x: ${3:x values, e.g. actual}",
-      "      y: ${4: y values, e.g. predicted}",
-      "      title: ${5:title, e.g. Predicted Probabilities}"
+      "      x: ${3:actual}",
+      "      y: ${4:predicted}",
+      "      title: ${5:Predicted Probabilities}"
     ],
     "description": "Single file dvc.yaml top level plot template"
   },
   "Multi-file Plot Template": {
     "prefix": "dvc-plot-multi",
     "body": [
-      "  - ${1:name, e.g. Accuracy}:",
+      "  - ${1:Accuracy}:",
       "      template: ${2|linear,simple,scatter,smooth,confusion,confusion_normalized,bar_horizontal,bar_horizontal_sorted|}",
-      "      x: ${3:x values, e.g. step}",
+      "      x: ${3:step}",
       "      y: ",
-      "        ${4:file, e.g. training/plots/metrics/train/acc.tsv}: ${5:y values, e.g. acc}",
-      "        ${6:file, e.g. training/plots/metrics/test/acc.tsv}: ${7:y values, e.g. acc}",
-      "      y_label: ${8:y label, e.g. accuracy}"
+      "        ${4:training/plots/metrics/train/acc.tsv}: ${5:acc}",
+      "        ${6:training/plots/metrics/test/acc.tsv}: ${7:acc}",
+      "      y_label: ${8:accuracy}"
     ],
     "description": "Multi-file dvc.yaml top level plot template"
   },
   "Bar Horizontal Plot Template": {
     "prefix": "dvc-plot-bar-horizontal",
     "body": [
-      "  - ${1:file, e.g. hist.csv}:",
+      "  - ${1:hist.csv}:",
       "      template: bar_horizontal",
-      "      x: ${2:x values, e.g. preds}",
-      "      y: ${3: y values, e.g. digit}",
-      "      title: ${4:title, e.g. Histogram of Predictions}"
+      "      x: ${2:preds}",
+      "      y: ${3:digit}",
+      "      title: ${4:Histogram of Predictions}"
     ],
     "description": "Bar horizontal dvc.yaml top level plot template"
   },
   "Confusion Matrix Plot Template": {
     "prefix": "dvc-plot-confusion",
     "body": [
-      "  - ${1:name, e.g. Confusion Matrix}:",
+      "  - ${1:Confusion Matrix}:",
       "      template: confusion",
-      "      x: ${2:x values, e.g. actual}",
+      "      x: ${2:actual}",
       "      y:",
-      "        ${3:file, e.g. training/plots/sklearn/confusion_matrix.json}: ${4:y values, e.g. predicted}"
+      "        ${3:training/plots/sklearn/confusion_matrix.json}: ${4:predicted}"
     ],
     "description": "Confusion matrix dvc.yaml top level plot template"
   },
   "Smooth Plot Template": {
     "prefix": "dvc-plot-smooth",
     "body": [
-      "  - ${1:file, e.g. acc.tsv}:",
-      "      x: ${2:x values, e.g. step}",
-      "      y: ${3: y values, e.g. acc}",
-      "      y_label: ${4: y label, e.g. accuracy}"
+      "  - ${1:acc.tsv}:",
+      "      x: ${2:step}",
+      "      y: ${3:acc}",
+      "      y_label: ${4:accuracy}"
     ],
     "description": "Smooth dvc.yaml top level plot template"
   },
   "Artifact": {
     "prefix": "dvc-artifact",
     "body": [
-      "  ${1:artifact id, e.g. cv-data}:",
-      "    path: ${2:path to artifact, e.g. data/data.xml}",
-      "    type: ${3:type of artifact, e.g. data}",
-      "    desc: '${4:artifact description, e.g. Preprocessed data for CV classification}'",
+      "  ${1:cv-data}:",
+      "    path: ${2:data/data.xml}",
+      "    type: ${3:data}",
+      "    desc: '${4:Preprocessed data for CV classification}'",
       "    labels:",
-      "      - ${5:list of labels, e.g. resnet50}"
+      "      - ${5:resnet50}"
     ],
     "description": "dvc.yaml artifact template"
   },
   "Model Artifact": {
     "prefix": "dvc-artifact-model",
     "body": [
-      "  ${1:artifact id, e.g. cv-classification}:",
-      "    path: ${2:path to model, e.g. models/resnet.pt}",
+      "  ${1:cv-classification}:",
+      "    path: ${2:models/resnet.pt}",
       "    type: model",
-      "    desc: '${3:model description, e.g. CV classification model, ResNet50}'",
+      "    desc: '${3:CV classification model, ResNet50}'",
       "    labels:",
-      "      - ${4:list of labels, e.g. resnet50}",
+      "      - ${4:resnet50}",
       "    meta:",
-      "      framework: ${5:framework name, e.g. pytorch}"
+      "      framework: ${5:pytorch}"
     ],
     "description": "dvc.yaml model artifact template"
   }