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

Revert "docs: Describe arbitrary metadata logging" #10099

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed docs/assets/images/webui-runs-metadata-filter.png
Binary file not shown.
2 changes: 0 additions & 2 deletions docs/get-started/webui-qs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ You must have a running Determined cluster with the CLI installed.
- To set up a remote cluster, visit the :ref:`Installation Guide <installation-guide>` where you'll
find options for On Prem, AWS, GCP, Kubernetes, and Slurm.

.. _qs-webui-concepts:

**********
Concepts
**********
Expand Down
12 changes: 2 additions & 10 deletions docs/reference/experiment-config-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1004,12 +1004,12 @@ Optional. The maximum number of trials that can be worked on simultaneously. The

Optional. If specified, the weights of *every* trial in the search will be initialized to the most
recent checkpoint of the given trial ID. This will fail if the source trial's model architecture is
inconsistent with the model architecture of any of the trials in this experiment.
incompatible with the model architecture of any of the trials in this experiment.

``source_checkpoint_uuid``
--------------------------

Optional. Like ``source_trial_id``, but specifies an arbitrary checkpoint from which to initialize
Optional. Like ``source_trial_id`` but specifies an arbitrary checkpoint from which to initialize
weights. At most one of ``source_trial_id`` or ``source_checkpoint_uuid`` should be set.

Grid
Expand Down Expand Up @@ -1654,11 +1654,3 @@ If :ref:`gres_supported <cluster-configuration-slurm>` is set to ``false``, spec
to ensure that ``slots_per_node`` GPUs will be available on the nodes selected for the job using
other configurations such as targeting a specific resource pool with only ``slots_per_node`` GPU
nodes or specifying a PBS constraint in the experiment configuration.

******************
Metadata Logging
******************

Determined supports logging arbitrary metadata for experiments. This feature allows users to store
additional context and information about their runs. To learn how to log custom metadata, visit
:ref:`the tutorial <metadata-logging-tutorial>`.
23 changes: 0 additions & 23 deletions docs/tools/webui-if.rst
Original file line number Diff line number Diff line change
Expand Up @@ -241,26 +241,3 @@ Clear the message with the following command:
.. code:: bash

det master cluster-message clear

********************************
Viewing and Filtering Metadata
********************************

You can use the WebUI to view and filter experiment runs based on logged metadata. For a tutorial on
how to log metadata, visit :ref:`metadata-logging-tutorial`.

- In the Overview tab of the experiment, you can filter and sort runs based on metadata values
using the filter menu.
- In the experiment's Runs view, metadata columns are displayed alongside other experiment
information.
- On the Run details page, you'll find the "Metadata" section under the "Overview" tab, displaying
all logged metadata for that run.
- To download the metadata in JSON format, click the "Download" button.

To filter runs based on metadata:

#. In the Runs view, click on the filter icon.
#. Select a metadata field from the dropdown menu.
#. Choose a condition (is, is not, or contains) and enter a value.

Note: Array-type metadata can be viewed but cannot be used for sorting or filtering.
1 change: 0 additions & 1 deletion docs/tutorials/_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ Examples let you build off of an existing model that already runs on Determined.
:hidden:

Quickstart for Model Developers <quickstart-mdldev>
Logging Arbitrary Metadata <metadata-logging>
Porting Your PyTorch Model to Determined <pytorch-mnist-tutorial>
Get Started with Detached Mode <detached-mode/_index>
Viewing Epoch-Based Metrics in the WebUI <viewing-epoch-based-metrics>
Expand Down
83 changes: 0 additions & 83 deletions docs/tutorials/metadata-logging.rst

This file was deleted.

10 changes: 0 additions & 10 deletions docs/tutorials/quickstart-mdldev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -352,16 +352,6 @@ This example uses a fixed batch size and searches on dropout size, filters, and
one trial performing at about 98 percent validation accuracy. The hyperparameter search halts
poorly performing trials.

*************************
Logging Custom Metadata
*************************

Determined also supports logging custom metadata during a trial run. This feature allows you to
capture additional context and information about your experiments beyond standard metrics.

To learn more about how to use metadata logging in your experiments, please refer to the
:ref:`metadata-logging-tutorial`.

************
Learn More
************
Expand Down
Loading