metadata

Edit, remove, dump or load metadata from a checkpoint file.

usage: anemoi-utils metadata [-h]
                             (--dump | --load | --edit | --view | --remove | --supporting-arrays | --get GET | --pytest | --peek)
                             [--name NAME] [--input INPUT] [--output OUTPUT]
                             [--inplace] [--editor EDITOR] [--pager PAGER]
                             [--json] [--yaml]
                             path

Positional Arguments

path

Path to the checkpoint.

Named Arguments

--dump

Extract the metadata from the checkpoint and print it to the standard output or the file specified by --output, in JSON or YAML format.

Default: False

--load

Set the metadata in the checkpoint from the content of a file specified by the --input argument.

Default: False

--edit

Edit the metadata in place, using the specified editor. See the --editor argument for more information.

Default: False

--view

View the metadata in place, using the specified pager. See the --pager argument for more information.

Default: False

--remove

Remove the metadata from the checkpoint.

Default: False

--supporting-arrays

Print the supporting arrays.

Default: False

--get

Navigate the metadata via dot-separated path.

--pytest

Extract the metadata from the checkpoint so it can be added to the test suite.

Default: False

--peek

Peek into the pickled model.

Default: False

--name

Name of metadata record to be used with the actions above.

Default: 'anemoi.json'

--input

The input file name to be used by the --load option.

--output

The output file name to be used by the --dump option.

--inplace

If set, update the source file in place instead of writing to a separate target.

Default: False

--editor

Editor to use for the --edit option. Default to $EDITOR if defined, else vi.

Default: 'vi'

--pager

Editor to use for the --view option. Default to $PAGER if defined, else less.

Default: 'less'

--json

Use the JSON format with --dump, --view, --get and --edit.

Default: False

--yaml

Use the YAML format with --dump, --view, --get and --edit.

Default: False