From 5c76b16e274874e83580e1a0539b4ed3eee2f67f Mon Sep 17 00:00:00 2001 From: Guangqing Tang <40620519+gt2345@users.noreply.github.com> Date: Wed, 24 May 2023 14:00:38 -0500 Subject: [PATCH] docs: Add release notes for 0.22.2 (#6954) --- docs/release-notes.rst | 38 +++++++++++++++++++ .../command-config-cli-bind-mounts.rst | 6 --- docs/release-notes/deprecate-template-set.rst | 5 --- .../dont-accept-epoch-bad-values.rst | 6 --- docs/release-notes/fix-det-e-list-cli.rst | 9 ----- docs/release-notes/launcher_329.rst | 8 ---- docs/release-notes/remove-legacy-apis.rst | 8 ---- 7 files changed, 38 insertions(+), 42 deletions(-) delete mode 100644 docs/release-notes/command-config-cli-bind-mounts.rst delete mode 100644 docs/release-notes/deprecate-template-set.rst delete mode 100644 docs/release-notes/dont-accept-epoch-bad-values.rst delete mode 100644 docs/release-notes/fix-det-e-list-cli.rst delete mode 100644 docs/release-notes/launcher_329.rst delete mode 100644 docs/release-notes/remove-legacy-apis.rst diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 2cc7ebe1df1..aad0768661b 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -10,6 +10,44 @@ Version 0.22 ************** +Version 0.22.2 +============== + +**Release Date:** May 24, 2023 + +**Improvements** + +- Cluster: Slurm/PBS requires HPC Launcher 3.2.9. + + - The HPC Launcher includes new support to enable improved scalablity. When used with Slurm or + PBS, the launcher must be version 3.2.9 or greater. + +- Bind mounts for notebooks (and other commands) can be configured with ``--config``. For example + usage, see the section for ``--config`` in ``det command run --help``. + +- Trials: Reporting a training or validation metric with the epoch set to a non-numeric value will + now return an error. + +**Deprecated Features** + +- CLI: ``det template set `` has been deprecated. + +**Removed Features** + +- API: Legacy APIs for trial details and trial metrics, which were deprecated in 0.19.2, have now + been removed. +- API: Legacy APIs for experiment creation and updates, which were deprecated in 0.19.10, have now + been removed. + +**Bug Fixes** + +- CLI: ``det e list`` and ``det e list -a`` behaviors were erroneously switched. + + - Earlier, ``det e list`` was showing both archived and unarchived experiments, and ``det e list + -a`` was showing only unarchived experiments. This has now been fixed --- ``det e list`` will + show only unarchived experiments and ``det e list -a`` will show both archived and unarchived + experiments. + Version 0.22.1 ============== diff --git a/docs/release-notes/command-config-cli-bind-mounts.rst b/docs/release-notes/command-config-cli-bind-mounts.rst deleted file mode 100644 index f28b3adea62..00000000000 --- a/docs/release-notes/command-config-cli-bind-mounts.rst +++ /dev/null @@ -1,6 +0,0 @@ -:orphan: - -**Improvements** - -- Bind mounts for notebooks (and other commands) can be configured with ``--config``. For example - usage, see the section for `--config` in `det command run --help`. diff --git a/docs/release-notes/deprecate-template-set.rst b/docs/release-notes/deprecate-template-set.rst deleted file mode 100644 index b558a531639..00000000000 --- a/docs/release-notes/deprecate-template-set.rst +++ /dev/null @@ -1,5 +0,0 @@ -:orphan: - -**Deprecated Features** - -- CLI: ``det template set `` has been deprecated. diff --git a/docs/release-notes/dont-accept-epoch-bad-values.rst b/docs/release-notes/dont-accept-epoch-bad-values.rst deleted file mode 100644 index ae16f664adf..00000000000 --- a/docs/release-notes/dont-accept-epoch-bad-values.rst +++ /dev/null @@ -1,6 +0,0 @@ -:orphan: - -**Improvements** - -- Trials: Reporting a training or validation metric with 'epoch' set to a non-numeric value will - now return an error. diff --git a/docs/release-notes/fix-det-e-list-cli.rst b/docs/release-notes/fix-det-e-list-cli.rst deleted file mode 100644 index 4fcf633a015..00000000000 --- a/docs/release-notes/fix-det-e-list-cli.rst +++ /dev/null @@ -1,9 +0,0 @@ -:orphan: - -**Bug Fixes** - -- CLI: ``det e list`` and ``det e list -a`` behaviors were erroneously switched. - - Earlier, ``det e list`` was showing both archived and unarchived experiments, and ``det e - list -a`` was showing only unarchived experiments. This has now been fixed - ``det e list`` - will show only unarchived experiments and ``det e list -a`` will show both archived and - unarchived experiments. diff --git a/docs/release-notes/launcher_329.rst b/docs/release-notes/launcher_329.rst deleted file mode 100644 index 8b0a6063b57..00000000000 --- a/docs/release-notes/launcher_329.rst +++ /dev/null @@ -1,8 +0,0 @@ -:orphan: - -**Improvements** - -- Cluster: Slurm/PBS requires HPC Launcher 3.2.9. - - - The HPC Launcher includes new support to enable improved scalablity. When used with Slurm or - PBS, the launcher must version 3.2.9 or greater. diff --git a/docs/release-notes/remove-legacy-apis.rst b/docs/release-notes/remove-legacy-apis.rst deleted file mode 100644 index 10c243a2711..00000000000 --- a/docs/release-notes/remove-legacy-apis.rst +++ /dev/null @@ -1,8 +0,0 @@ -:orphan: - -**Removed Features** - -- API: Legacy APIs for trial details and trial metrics, which were deprecated in 0.19.2, have now - been removed. -- API: Legacy APIs for experiment creation and updates, which were deprecated in 0.19.10, have now - been removed.