docs: add release notes for 0.19.6 (#5357)

determined-ai · Oct 28, 2022 · 2766fd1 · 2766fd1
1 parent 4cb7414
commit 2766fd1
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 76 deletions.
diff --git 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
+   <https://www.hpe.com/us/en/solutions/artificial-intelligence/machine-learning-development-environment.html>`_
+   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
diff --git a/docs/release-notes/5150-slurm.txt b/docs/release-notes/5150-slurm.txt
diff --git a/docs/release-notes/5188-ls-for-all-cli.txt b/docs/release-notes/5188-ls-for-all-cli.txt
diff --git a/docs/release-notes/5205-custom-searcher.txt b/docs/release-notes/5205-custom-searcher.txt
diff --git a/docs/release-notes/FOUNDENG-184-PBS.rst b/docs/release-notes/FOUNDENG-184-PBS.rst
diff --git a/docs/release-notes/det-deploy-clean-orphaned.rst b/docs/release-notes/det-deploy-clean-orphaned.rst
diff --git a/docs/release-notes/remove-echo-get-task.rst b/docs/release-notes/remove-echo-get-task.rst