Skip to content

Commit

Permalink
docs: add release notes for 0.30.0 (#9103)
Browse files Browse the repository at this point in the history
release notes for 0.30.0
  • Loading branch information
wes-turner authored Apr 4, 2024
1 parent c108443 commit 97aaa02
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 36 deletions.
47 changes: 47 additions & 0 deletions docs/release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,53 @@
Release Notes
###############

**************
Version 0.30
**************

Version 0.30.0
==============

**Release Date:** April 04, 2024

**Breaking Changes**

- API: :class:`~determined.pytorch.Trainer` no longer supports the ``Trainer.configure_profiler``
option. Profiling is now enabled through the ``Trainer.fit(profiling_enabled=True)`` call.

- Database migration: System metrics collected by the Determined profiler are now stored in the
generic ``metrics`` table. This requires a few schema changes to the ``metrics`` table that will
be run during migrations.

.. important::

This migration may take more time for deployments with a large amount of stored metrics.

**New Features**

- Core API: The Determined profiler is now accessible from the Core API. It collects system
metrics, which can be viewed in the WebUI under the experiment's "Profiler" tab. See the
:ref:`Core API guide <core-profiler>` for details.

**Removed Features**

- Profiler: Support for timing metrics and related configurations has been removed. The Determined
profiler now only collects system metrics and defers to our native profiler integrations for
training-specific profiling. Users are encouraged to configure profilers native to their
:ref:`training API <apis-howto-overview>` for this functionality.

- Historical data for timing metrics is retained in the ``trial_profiler_metrics`` database
table, but they are no longer being collected or rendered in the WebUI.

- Historical data for system metrics generated by trials before this release are not
automatically migrated due to time cost. For users wanting to view historical system metrics
in the WebUI, we provide an `optional migration script
<https://github.com/determined-ai/determined/blob/main/master/static/optional_migrations/20240325144732_trial-profiler-metrics-migration.tx.up.sql>`__
that can be run manually.

- Configuration: The ``timings_enabled``, ``begin_on_batch``, and ``end_after_batch`` options in
the ``profiling`` section of experiment configurations are no longer supported.

**************
Version 0.29
**************
Expand Down
36 changes: 0 additions & 36 deletions docs/release-notes/profiling-v2.rst

This file was deleted.

0 comments on commit 97aaa02

Please sign in to comment.