akka optimize training runs annotate

Update annotations and configuration name for a training run

Synopsis

Set a description or configuration display name for a training run.

Annotations do not modify run identifiers or references. You can annotate a run at any point during or after execution.

The value of --config-name appears as the column header in "training workloads scores". If runs of the same configuration have different names, the most recently set name is used.

akka optimize training runs annotate RUN [flags]

Examples

  # Add a description to a run
  akka-optimize training runs annotate 7d496e82c3a15f04 --description "Baseline sweep"

  # Set a configuration name for score comparison tables
  akka-optimize training runs annotate 7d496e82c3a15f04 --config-name rank16-lr2e-4

Options

      --config-name string   Column header for this configuration in comparison tables. Pass an empty string to clear
      --description string   Description for the resource. Pass an empty string to clear
  -h, --help                 help for annotate

Options inherited from parent commands

      --cache-file string    location of cache file (default "~/.akka/cache.yaml")
      --config string        location of config file (default "~/.akka/config.yaml")
      --context string       configuration context to use
      --disable-prompt       Disable all interactive prompts when running akka commands. If input is required, defaults will be used, or an error will be raised.
                             This is equivalent to setting the environment variable AKKA_DISABLE_PROMPTS to true.
      --force                Skip the confirmation prompt
      --jq string            Filter the JSON output with a jq expression
      --json string          Output JSON with only these fields; --json= lists the fields a command offers
      --no-color             Print without color, as NO_COLOR does
  -o, --output string        set output format to one of [text,json,json-compact,go-template=] (default "text")
      --page-mode string     the mode for paging, either paged, buffered or auto. (default "auto")
  -q, --quiet                set quiet output (helpful when used as part of a script)
      --region string        Region to use if the project has more than one region
      --timeout duration     client command timeout (default 10s)
      --trainer-url string   Trainer service URL (default http://localhost:9001, or TRAINER_URL)
      --url string           Optimize service URL (default http://localhost:9010, or OPTIMIZE_URL)
      --use-grpc-web         use grpc-web when talking to Akka APIs. This is useful when behind corporate firewalls that decrypt traffic but don't support HTTP/2.
      --verbose              set verbose output

SEE ALSO