Get model card in TRITONSERVER_ServerModelMetadata

Signed-off-by: Xiaodong Ye <[email protected]>
triton-inference-server · May 14, 2023 · 68e0986 · 68e0986
1 parent 75dbd17
commit 68e0986
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/src/constants.h b/src/constants.h
@@ -71,6 +71,7 @@ constexpr char kAutoMixedPrecisionExecutionAccelerator[] =
     "auto_mixed_precision";
 
 constexpr char kModelConfigPbTxt[] = "config.pbtxt";
+constexpr char kModelCard[] = "README.md";
 
 constexpr char kMetricsLabelModelName[] = "model";
 constexpr char kMetricsLabelModelVersion[] = "version";

diff --git a/src/model.cc b/src/model.cc
@@ -36,6 +36,15 @@
 
 namespace triton { namespace core {
 
+Status
+Model::GetCard(std::string* contents) const
+{
+  const auto card_path = JoinPath({model_dir_, kModelCard});
+  RETURN_IF_ERROR(ReadTextFile(card_path, contents));
+
+  return Status::Success;
+}
+
 Status
 Model::GetInput(
     const std::string& name, const inference::ModelInput** input) const

diff --git a/src/model.h b/src/model.h
@@ -146,6 +146,9 @@ class Model {
     return stats_aggregator_;
   }
 
+  // Get the model card for the model being served.
+  Status GetCard(std::string* contents) const;
+
   // Get the model configuration for a named input.
   Status GetInput(
       const std::string& name, const inference::ModelInput** input) const;

diff --git a/src/tritonserver.cc b/src/tritonserver.cc
@@ -2634,6 +2634,13 @@ TRITONSERVER_ServerModelMetadata(
         metadata.AddStringRef("platform", model_config.backend().c_str()));
   }
 
+  std::string card;
+  model->GetCard(&card);
+  if (!card.empty()) {
+      RETURN_IF_STATUS_ERROR(
+        metadata.AddStringRef("card", card.c_str()));
+  }
+
   triton::common::TritonJson::Value inputs(
       metadata, triton::common::TritonJson::ValueType::ARRAY);
   for (const auto& io : model_config.input()) {