From 2766fd1e75e12640f46c0718e8f7da3df6465a28 Mon Sep 17 00:00:00 2001 From: Emily <15078396+EmilyBonar@users.noreply.github.com> Date: Fri, 28 Oct 2022 14:25:31 -0500 Subject: [PATCH] docs: add release notes for 0.19.6 (#5357) --- docs/release-notes.rst | 66 +++++++++++++++++++ .../5087-single-file-context.txt | 15 ----- docs/release-notes/5150-slurm.txt | 25 ------- docs/release-notes/5188-ls-for-all-cli.txt | 5 -- docs/release-notes/5205-custom-searcher.txt | 7 -- docs/release-notes/FOUNDENG-184-PBS.rst | 11 ---- .../det-deploy-clean-orphaned.rst | 7 -- docs/release-notes/remove-echo-get-task.rst | 6 -- 8 files changed, 66 insertions(+), 76 deletions(-) delete mode 100644 docs/release-notes/5087-single-file-context.txt delete mode 100644 docs/release-notes/5150-slurm.txt delete mode 100644 docs/release-notes/5188-ls-for-all-cli.txt delete mode 100644 docs/release-notes/5205-custom-searcher.txt delete mode 100644 docs/release-notes/FOUNDENG-184-PBS.rst delete mode 100644 docs/release-notes/det-deploy-clean-orphaned.rst delete mode 100644 docs/release-notes/remove-echo-get-task.rst diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 0604d9b02e1..c6f6a2b178c 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -10,6 +10,72 @@ Version 0.19 ************** +Version 0.19.6 +============== + +**Release Date:** October 28, 2022 + +**Breaking Changes** + +- API: Remove the legacy endpoint ``/tasks/:task_id`` due to it always incorrectly returning a + missing parameter. + +- Experiment: Additional Slurm options formerly specified in the experiment environment section are + now part of a new ``slurm`` section of the experiment configuration. For example, what was + formerly written as + + .. code:: yaml + + environment: + ... + slurm: + - --mem-per-cpu=10 + - --exclusive + + is now specified as + + .. code:: yaml + + environment: + ... + slurm: + sbatch_args: + - --mem-per-cpu=10 + - --exclusive + +**Improvements** + +- CLI: Add the ``ls`` abbreviation for ``list`` to all applicable CLI commands. + +- CLI: Support a new ``-i``/``--include`` option in task-starting CLI commands. The context option + (``--context``) is useful for copying a directory of files into the task container, but it may + only be provided once, and it can be clunky if you only care about one or two files. The + ``--include`` option also copies files into the task container, but: + + - The directory name is preserved, so ``-i my_data/`` would result in a directory named + ``my_data/`` appearing in the working directory of the task container. + - It may point to a file, so ``-i my_data.csv`` will place ``my_data.csv`` into the working + directory. + - It may be specified multiple times to include multiple files and/or directories. + +- **Breaking Change:** ``det deploy aws`` by default now configures agent instances to + automatically shut down if they lose their connection to the master. The + ``--no-shut-down-agents-on-connection-loss`` option can be used to turn off this behavior. + +**New Features** + +- The custom searcher API allows users to implement their own logic to coordinate across multiple + training jobs, enabling easy implementation of custom meta algorithms like hyperparameter tuning + and ensembling methods. See :ref:`topic-guides_hp-tuning-det_custom` for more information. + +- Cluster: The enterprise edition of `HPE Machine Learning Development Environment + `_ + can now be deployed on a PBS cluster. When using PBS scheduler, HPE Machine Learning Development + Environment delegates all job scheduling and prioritization to the PBS workload manager. This + integration enables existing PBS workloads and HPE Machine Learning Development Environment + workloads to coexist and access all of the advanced capabilities of the PBS workload manager. You + can use either Singularity or Podman for the container runtime. + Version 0.19.5 ============== diff --git a/docs/release-notes/5087-single-file-context.txt b/docs/release-notes/5087-single-file-context.txt deleted file mode 100644 index cd8ed3729e9..00000000000 --- a/docs/release-notes/5087-single-file-context.txt +++ /dev/null @@ -1,15 +0,0 @@ -:orphan: - -**Improvements** - -- Support a new ``-i``/``--include`` option in task-starting CLI commands. The context option - (``--context``) is useful for copying a directory of files into the task container, but it may - only be provided once, and it can be clunky if you only care about one or two files. The - Include option also copies files into the task container, but: - - - The directory name is preserved, so ``-i my_data/`` would result in a directory named - ``my_data/`` appearing in the working directory of the task container. - - - It may point to a file, so ``-i my_data.csv`` will work. - - - It may be specified multiple times to include multiple files and/or directories. diff --git a/docs/release-notes/5150-slurm.txt b/docs/release-notes/5150-slurm.txt deleted file mode 100644 index 058c49ef201..00000000000 --- a/docs/release-notes/5150-slurm.txt +++ /dev/null @@ -1,25 +0,0 @@ -:orphan: - -**Breaking Changes** - -- Additional Slurm options formerly specified in the experiment environment section - are now part of a new Slurm section of the experiment configuration. For example, - what was formerly written as: - - .. code:: yaml - environment: - ... - slurm: - - --mem-per-cpu=10 - - --exclusive - - Is now specified as: - - .. code:: yaml - environment: - ... - slurm: - sbatch_args: - - --mem-per-cpu=10 - - --exclusive - diff --git a/docs/release-notes/5188-ls-for-all-cli.txt b/docs/release-notes/5188-ls-for-all-cli.txt deleted file mode 100644 index 077ca6df565..00000000000 --- a/docs/release-notes/5188-ls-for-all-cli.txt +++ /dev/null @@ -1,5 +0,0 @@ -:orphan: - -**Improvements** - -- CLI: Add the `ls` abbreviation for `list` to all applicable CLI commands. diff --git a/docs/release-notes/5205-custom-searcher.txt b/docs/release-notes/5205-custom-searcher.txt deleted file mode 100644 index bb69ce94708..00000000000 --- a/docs/release-notes/5205-custom-searcher.txt +++ /dev/null @@ -1,7 +0,0 @@ -:orphan: - -**New Features** - -- The custom searcher API allows users to implement their own logic to coordinate across multiple - training jobs, enabling easy implementation of custom meta algorithms like hyperparameter tuning - and ensembling methods. See :ref:`topic-guides_hp-tuning-det_custom` for more information. diff --git a/docs/release-notes/FOUNDENG-184-PBS.rst b/docs/release-notes/FOUNDENG-184-PBS.rst deleted file mode 100644 index a5254170c50..00000000000 --- a/docs/release-notes/FOUNDENG-184-PBS.rst +++ /dev/null @@ -1,11 +0,0 @@ -:orphan: - -**New Features** - -- Cluster: The enterprise edition of `HPE Machine Learning Development Environment - `_ - can now be deployed on a PBS cluster. When using PBS scheduler, HPE Machine Learning Development - Environment delegates all job scheduling and prioritization to the PBS workload manager. This - integration enables existing PBS workloads and HPE Machine Learning Development Environment - workloads to coexist and access all of the advanced capabilities of the PBS workload manager. You - can use either Singularity or Podman for the container runtime. diff --git a/docs/release-notes/det-deploy-clean-orphaned.rst b/docs/release-notes/det-deploy-clean-orphaned.rst deleted file mode 100644 index 992af820050..00000000000 --- a/docs/release-notes/det-deploy-clean-orphaned.rst +++ /dev/null @@ -1,7 +0,0 @@ -:orphan: - -**Improvements** - -- **Breaking Change:** ``det deploy aws`` by default now configures agent instances to - automatically shut down if they lose their connection to the master. The - ``--no-shut-down-agents-on-connection-loss`` option can be used to turn off this behavior. diff --git a/docs/release-notes/remove-echo-get-task.rst b/docs/release-notes/remove-echo-get-task.rst deleted file mode 100644 index 13e484a9d07..00000000000 --- a/docs/release-notes/remove-echo-get-task.rst +++ /dev/null @@ -1,6 +0,0 @@ -:orphan: - -**Breaking Changes** - -- API: removed legacy endpoint ``/tasks/:task_id`` due to it always incorrectly returning missing - parameter.