Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add release notes for 0.30.0 #9103

Merged
merged 3 commits into from
Apr 4, 2024
Merged

Conversation

wes-turner
Copy link
Contributor

Add release notes for 0.30.0.

@determined-ci
Copy link
Collaborator

Docsite preview being generated for this PR.
You can (eventually) find the generated docsite here.

@determined-ci determined-ci requested a review from a team April 3, 2024 22:25
@determined-ci determined-ci added the documentation Improvements or additions to documentation label Apr 3, 2024
@determined-ci
Copy link
Collaborator

Docsite preview being generated for this PR.
You can (eventually) find the generated docsite here.

Copy link

codecov bot commented Apr 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 43.43%. Comparing base (c108443) to head (5555176).

Additional details and impacted files
@@                Coverage Diff                 @@
##           release-0.30.0    #9103      +/-   ##
==================================================
- Coverage           47.43%   43.43%   -4.01%     
==================================================
  Files                1165      723     -442     
  Lines              143670   102030   -41640     
  Branches             2347     2349       +2     
==================================================
- Hits                68151    44312   -23839     
+ Misses              75360    57559   -17801     
  Partials              159      159              
Flag Coverage Δ
backend 34.24% <ø> (-8.55%) ⬇️
harness 49.81% <ø> (-14.51%) ⬇️
web 39.95% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 576 files with indirect coverage changes


- 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Database migration: System metrics...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Others too, don't forget.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalized!

.. important::

This migration will be more time-consuming for deployments with a large amount of metrics stored.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.. important::

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

**New Features**

- Core API: the Determined profiler is now accessible from the Core API. It collects system
metrics, which can be viewed in the Web UI under the experiment's "Profiler" tab. See the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WebUI (rather than "Web UI")


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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this page exist?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! It points here: model-dev-guide/api-guides/apis-howto/api-core-ug.html#core-profiler

: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 Web UI.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Web UI, we provide an `optional migration script
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WebUI

Copy link
Member

@tara-det-ai tara-det-ai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, added suggestions for consistency

generic ``metrics`` table. This requires a few schema changes to the ``metrics`` table that will
be run during migrations.

.. important::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indent so it's part of the list item.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


**Removed Features**

- Profiler: support for timing metrics and related configurations have been removed. The Determined
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Profiler: support for timing metrics and related configurations have been removed. The Determined
- Profiler: Support for timing metrics and related configurations has been removed. The Determined

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice catch!


- 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Others too, don't forget.

@determined-ci
Copy link
Collaborator

Docsite preview being generated for this PR.
You can (eventually) find the generated docsite here.

@determined-ci determined-ci requested a review from a team April 4, 2024 18:19
@wes-turner wes-turner merged commit 97aaa02 into release-0.30.0 Apr 4, 2024
11 of 13 checks passed
@wes-turner wes-turner deleted the relnotes-0.30.0 branch April 4, 2024 18:20
wes-turner added a commit that referenced this pull request Apr 5, 2024
release notes for 0.30.0

(cherry picked from commit 97aaa02)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants