sources/gst-plugins/gst-nvinfereval/nvds_eval_config.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include <string>
#include <map>
#include <set>
#include <glib.h>
 
/* ------------------------------------------------------------------ */
/* GlobalConfig                                                        */
/* ------------------------------------------------------------------ */
 
struct GlobalConfig
{
  guint    eval_interval   = 1000;
  gfloat   iou_threshold   = 0.5f;
  gboolean show_gt_overlay     = FALSE;  /* draw GT boxes as green rects via nvosd */
  gboolean show_ap_table       = FALSE;  /* print per-class AP table to console */
  gboolean cumulative          = TRUE;   /* don't reset accumulator between epochs */
  gboolean exclude_undetected  = TRUE;   /* auto-exclude classes with 0 TP and 0 FP */
  std::set<std::string> exclude_classes; /* classes skipped in mean AP/P/R */
  std::string report_file;
  /* Fallback GT file used for any model that has no per-model gt-file. */
  std::string default_gt_file;
  /* Base URL of the nvmodelmux REST server (e.g. http://localhost:9000).
   * When a shadow wins an epoch, the win-action below is applied by POSTing to
   * <rest_url>/api/v1/model/routing. Empty (default) => no action taken. */
  std::string rest_url;
  /* Action when the shadow wins an epoch:
   *   0 = promote (default): winner -> primary, shadow cleared (A/B ends)
   *   1 = swap             : winner -> primary, loser -> shadow (A/B continues)
   *   2 = report-only      : no REST call, pure monitoring mode */
  guint promotion_mode = 0;
};
 
/* ------------------------------------------------------------------ */
/* ModelConfig                                                         */
/* ------------------------------------------------------------------ */
 
struct ModelConfig
{
  /* Empty → use GlobalConfig::default_gt_file */
  std::string gt_file;
 
  gfloat  min_ap_margin  = 0.02f;
  gfloat  kpi_ap50       = 0.0f;   /* 0 = disabled */
  gfloat  kpi_precision  = 0.0f;   /* 0 = disabled */
  gfloat  kpi_recall     = 0.0f;   /* 0 = disabled */
};
 
/* ------------------------------------------------------------------ */
/* EvalConfig                                                          */
/* ------------------------------------------------------------------ */
 
struct EvalConfig
{
  GlobalConfig                        global;
  std::map<std::string, ModelConfig>  models; /* model_name → per-model config */
 
  ModelConfig effective_model_config (const std::string &model_name) const;
};
 
/* ------------------------------------------------------------------ */
/* Loader                                                              */
/* ------------------------------------------------------------------ */
 
bool eval_config_load (const std::string &path, EvalConfig &cfg);