Metrics constitute the foundation of Encord Active. This section documents all the available commands on how to manage and run metrics in your projects.
Make sure your shell's current working directory is that of an Encord Active project, or your command points to one with the
--target global option.
metric add command adds metrics to the project.
These metrics can be listed, removed and run on the project data via other CLI commands.
You can add metrics from local python modules (
If you don't specify a metric, Encord Active will add all the metrics in the python module to the project.
encord-active metric add /path/to/module.py
You can also add specific metrics by using their title:
encord-active metric add /path/to/module.py "Metric Title" "Another Metric Title"
If you try to add a metric that is already present, it will be skipped and you will receive a notification.
In case a metric title is not found in the python module, you will get an error.
Some shells may treat square braces (
]) as special characters. It is suggested to always quote arguments containing these characters to prevent unexpected shell expansion.
metric remove command removes metrics from the project.
Deleted metrics will not be available to run on the project data, but their results will still appear in the UI.
encord-active metric remove "Metric Title"
metric run command runs metrics on the project data.
If you don't specify a metric, Encord Active will run all metrics available in the project.
encord-active metric run
You can also run specific metrics by using their title:
encord-active metric run "Metric Title" "Another Metric Title"
metric list command lists all metrics available in the project.
Metrics are listed in a case-insensitive sorted order.
encord-active metric list
metric show command shows detailed information about one or more metrics available in the project.
encord-active metric show "Metric Title"