diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 491f71035bb..d7286c3d343 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -10,6 +10,80 @@ Version 0.26 ************** +Version 0.26.2 +============== + +**Release Date:** October 25, 2023 + +Notice: The ``ruamel.yaml`` library's 0.18.0 release includes breaking changes that affect earlier +versions of Determined. The failure behavior is that commands that emit YAML, such as ``det +experiment config``, will emit nothing to ``stdout`` or ``stderr`` but instead silently exit 1 due +to the new version of ``ruamel.yaml``. This release of Determined has included a +``ruamel.yaml<0.18.0`` requirement, but older versions of Determined will also be affected, so users +of older versions of Determined may have to manually downgrade ``ruamel.yaml`` if they observe this +behavior. + +**New Features** + +- Python SDK: Add various new features and enhancements. A few highlights are listed below. + + - Add support for downloading a zipped archive of experiment code + (:meth:`Experiment.download_code <determined.experimental.client.Experiment.download_code>`). + + - Add support for :class:`~determined.experimental.client.Project` and + :class:`~determined.experimental.client.Workspace` as SDK objects. + + - Surface more attributes to resource classes, including ``hparams`` and ``summary_metrics`` for + :class:`~determined.experimental.client.Trial`. + + - Add support for fetching and filtering multiple experiments with + :meth:`client.list_experiments <determined.experimental.client.list_experiments>`. + + - Add support for filtering trial logs by timestamp and a query string using + :meth:`Trial.iter_logs <determined.experimental.client.Trial.iter_logs>`. + + - All resource objects now have a ``.reload()`` method that refreshes the resource's attributes + from the server. Previously, attributes were most easily refreshed by creating an entirely new + object. + +- Python SDK: All ``GET`` API calls now retry the request up to 5 times on failure. + +**Deprecated Features** + +- Python SDK: Several methods have been renamed for better API standardization. + + - Methods returning a ``List`` and ``Iterator`` now have names starting with ``list_*`` and + ``iter_*``, respectively. + + - :class:`~determined.experimental.client.TrialReference` and + :class:`~determined.experimental.client.ExperimentReference` are now + :class:`~determined.experimental.client.Trial` and + :class:`~determined.experimental.client.Experiment`. + +- Python SDK: Consolidate various ways of fetching checkpoints. + + - :meth:`Experiment.top_checkpoint <determined.experimental.client.Experiment.top_checkpoint>` + and :meth:`Experiment.top_n_checkpoints + <determined.experimental.client.Experiment.top_n_checkpoints>` are deprecated in favor of + :meth:`Experiment.list_checkpoints + <determined.experimental.client.Experiment.list_checkpoints>`. + + - :meth:`Trial.get_checkpoints <determined.experimental.client.Trial.get_checkpoints>`, + :meth:`Trial.top_checkpoint <determined.experimental.client.Trial.top_checkpoint>`, and + :meth:`Trial.select_checkpoint <determined.experimental.client.Trial.select_checkpoint>` are + deprecated in favor of :meth:`Trial.list_checkpoints + <determined.experimental.client.Trial.list_checkpoints>`. + +- Python SDK: Deprecate resource ordering enum classes (``CheckpointOrderBy``, + ``ExperimentOrderBy``, ``TrialOrderBy``, ``ModelOrderBy``) in favor of a shared + :class:`~determined.experimental.client.OrderBy`. + +**Bug Fixes** + +- Core API: On context closure, properly save all TensorBoard files not related to metrics + reporting, particularly the native profiler traces. +- Core API v2: Fix an issue where TensorBoard files were not saved for managed experiments. + Version 0.26.1 ============== diff --git a/docs/release-notes/core-v2-tensorboard.rst b/docs/release-notes/core-v2-tensorboard.rst deleted file mode 100644 index 4854a4767e0..00000000000 --- a/docs/release-notes/core-v2-tensorboard.rst +++ /dev/null @@ -1,7 +0,0 @@ -:orphan: - -**Bug Fixes** - -- Core API: On context closure, properly save all TensorBoard files not related to metrics - reporting, particularly the native profiler traces. -- Core API v2: Fix an issue where TensorBoard files were not saved for managed experiments. diff --git a/docs/release-notes/python-sdk.rst b/docs/release-notes/python-sdk.rst deleted file mode 100644 index 885df11c0e1..00000000000 --- a/docs/release-notes/python-sdk.rst +++ /dev/null @@ -1,54 +0,0 @@ -:orphan: - -**New Features** - -- Python SDK: various new features and enhancements. A few highlights are listed below. - - Add support for downloading a zipped archive of experiment code - (:meth:`Experiment.download_code - <determined.experimental.client.Experiment.download_code>`). - - - Add support for :class:`~determined.experimental.client.Project` and - :class:`~determined.experimental.client.Workspace` as SDK objects. - - - Surface more attributes to resource classes, including ``hparams`` and ``summary_metrics`` - for :class:`~determined.experimental.client.Trial`. - - - Add support for fetching and filtering multiple experiments with - :meth:`client.list_experiments <determined.experimental.client.list_experiments>`. - - - Add support for filtering trial logs by timestamp and a query string using - :meth:`Trial.iter_logs <determined.experimental.client.Trial.iter_logs>`. - - - All resource objects now have a ``.reload()`` method that refreshes the resource's - attributes from the server. Previously, attributes were most easily refreshed by creating - an entirely new object. - -- Python SDK: all ``GET`` API calls now retry the request (maximum of 5 times) on failure. - -**Deprecated Features** - -- Python SDK: several methods have been renamed for better API standardization. - - ``list_*`` and ``iter_*`` for methods returning a ``List`` and ``Iterator``, respectively. - - - :class:`~determined.experimental.client.TrialReference` and - :class:`~determined.experimental.client.ExperimentReference` are now - :class:`~determined.experimental.client.Trial` and - :class:`~determined.experimental.client.Experiment`. - -- Python SDK: consolidate various ways of fetching checkpoints. - - :meth:`Experiment.top_checkpoint - <determined.experimental.client.Experiment.top_checkpoint>`, and - :meth:`Experiment.top_n_checkpoints - <determined.experimental.client.Experiment.top_n_checkpoints>` deprecated in favor of - :meth:`Experiment.list_checkpoints - <determined.experimental.client.Experiment.list_checkpoints>`. - - - :meth:`Trial.get_checkpoints <determined.experimental.client.Trial.get_checkpoints>`, - :meth:`Trial.top_checkpoint <determined.experimental.client.Trial.top_checkpoint>`, and - :meth:`Trial.select_checkpoint <determined.experimental.client.Trial.select_checkpoint>` - deprecated in favor of :meth:`Trial.list_checkpoints - <determined.experimental.client.Trial.list_checkpoints>`. - -- Python SDK: deprecate resource ordering enum classes (``CheckpointOrderBy``, - ``ExperimentOrderBy``, ``TrialOrderBy``, ``ModelOrderBy``) in favor of a singular shared - :class:`~determined.experimental.client.OrderBy`.