ShowModelDetailsCommand Class Reference

#include <DdlCommandExecutor.h>

Inheritance diagram for ShowModelDetailsCommand:

Collaboration diagram for ShowModelDetailsCommand:

Public Member Functions
	ShowModelDetailsCommand (const DdlCommandData &ddl_data, std::shared_ptr< Catalog_Namespace::SessionInfo const > session_ptr)
ExecutionResult	execute (bool read_only_mode) override
Public Member Functions inherited from DdlCommand
	DdlCommand (const DdlCommandData &ddl_data, std::shared_ptr< Catalog_Namespace::SessionInfo const > session_ptr)

Private Member Functions
std::vector< std::string >	getFilteredModelNames ()

Additional Inherited Members
Protected Attributes inherited from DdlCommand
const DdlCommandData &	ddl_data_
std::shared_ptr < Catalog_Namespace::SessionInfo const >	session_ptr_

Detailed Description

Definition at line 280 of file DdlCommandExecutor.h.

Constructor & Destructor Documentation

ShowModelDetailsCommand::ShowModelDetailsCommand	(	const DdlCommandData &	ddl_data,
		std::shared_ptr< Catalog_Namespace::SessionInfo const >	session_ptr
	)

Definition at line 2094 of file DdlCommandExecutor.cpp.

References g_enable_ml_functions, and g_restrict_ml_model_metadata_to_superusers.

    : DdlCommand(ddl_data, session_ptr) {
  if (!g_enable_ml_functions) {
    throw std::runtime_error("Cannot show model details. ML functions are disabled.");
  }
  if (g_restrict_ml_model_metadata_to_superusers) {
    // Check if user is super user
    const auto& current_user = session_ptr->get_currentUser();
    if (!current_user.isSuper) {
      throw std::runtime_error(
          "Cannot show model details. Showing model information to non-superusers is "
          "disabled.");
    }
  }
}

Member Function Documentation

ExecutionResult ShowModelDetailsCommand::execute ( bool  read_only_mode )

overridevirtual

Executes the DDL command corresponding to provided JSON payload.

Parameters

_return

result of DDL command execution (if applicable)

Implements DdlCommand.

Definition at line 2112 of file DdlCommandExecutor.cpp.

References ResultSetLogicalValuesBuilder::create(), g_ml_models, anonymous_namespace{DdlCommandExecutor.cpp}::genLiteralBigInt(), anonymous_namespace{DdlCommandExecutor.cpp}::genLiteralDouble(), genLiteralStr(), legacylockmgr::getExecuteReadLock(), getFilteredModelNames(), MLModelMap::getModelMetadata(), kBIGINT, kDOUBLE, and kTEXT.

Referenced by heavydb.cursor.Cursor::executemany().

                                                                    {
  auto execute_read_lock = legacylockmgr::getExecuteReadLock();

  std::vector<TargetMetaInfo> label_infos;
  label_infos.emplace_back("model_name", SQLTypeInfo(kTEXT, true));
  label_infos.emplace_back("model_type", SQLTypeInfo(kTEXT, true));
  label_infos.emplace_back("predicted", SQLTypeInfo(kTEXT, true));
  label_infos.emplace_back("features", SQLTypeInfo(kTEXT, true));
  label_infos.emplace_back("training_query", SQLTypeInfo(kTEXT, true));
  label_infos.emplace_back("num_logical_features", SQLTypeInfo(kBIGINT, true));
  label_infos.emplace_back("num_physical_features", SQLTypeInfo(kBIGINT, true));
  label_infos.emplace_back("num_categorical_features", SQLTypeInfo(kBIGINT, true));
  label_infos.emplace_back("num_numeric_features", SQLTypeInfo(kBIGINT, true));
  label_infos.emplace_back("train_fraction", SQLTypeInfo(kDOUBLE, true));
  label_infos.emplace_back("eval_fraction", SQLTypeInfo(kDOUBLE, true));

  // Get all model names
  const auto model_names = getFilteredModelNames();

  // logical_values -> table data
  std::vector<RelLogicalValues::RowValues> logical_values;
  for (auto& model_name : model_names) {
    logical_values.emplace_back(RelLogicalValues::RowValues{});
    logical_values.back().emplace_back(genLiteralStr(model_name));
    const auto model_metadata = g_ml_models.getModelMetadata(model_name);
    logical_values.back().emplace_back(genLiteralStr(model_metadata.getModelTypeStr()));
    logical_values.back().emplace_back(genLiteralStr(model_metadata.getPredicted()));
    const auto& features = model_metadata.getFeatures();
    std::ostringstream features_oss;
    bool is_first_feature = true;
    for (auto& feature : features) {
      if (!is_first_feature) {
        features_oss << ", ";
      } else {
        is_first_feature = false;
      }
      features_oss << feature;
    }
    auto features_str = features_oss.str();
    logical_values.back().emplace_back(genLiteralStr(features_str));
    logical_values.back().emplace_back(genLiteralStr(model_metadata.getTrainingQuery()));
    logical_values.back().emplace_back(
        genLiteralBigInt(model_metadata.getNumLogicalFeatures()));
    logical_values.back().emplace_back(genLiteralBigInt(model_metadata.getNumFeatures()));
    logical_values.back().emplace_back(
        genLiteralBigInt(model_metadata.getNumCategoricalFeatures()));
    logical_values.back().emplace_back(
        genLiteralBigInt(model_metadata.getNumLogicalFeatures() -
                         model_metadata.getNumCategoricalFeatures()));
    logical_values.back().emplace_back(
        genLiteralDouble(model_metadata.getDataSplitTrainFraction()));
    logical_values.back().emplace_back(
        genLiteralDouble(model_metadata.getDataSplitEvalFraction()));
  }

  // Create ResultSet
  std::shared_ptr<ResultSet> rSet = std::shared_ptr<ResultSet>(
      ResultSetLogicalValuesBuilder::create(label_infos, logical_values));

  return ExecutionResult(rSet, label_infos);
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::vector< std::string > ShowModelDetailsCommand::getFilteredModelNames ( )

private

Definition at line 2174 of file DdlCommandExecutor.cpp.

References DdlCommand::ddl_data_, anonymous_namespace{DdlCommandExecutor.cpp}::extractPayload(), g_ml_models, MLModelMap::getModelNames(), and to_upper().

Referenced by execute().

                                                                    {
  auto& ddl_payload = extractPayload(ddl_data_);
  auto all_model_names = g_ml_models.getModelNames();
  if (ddl_payload.HasMember("modelNames")) {
    std::vector<std::string> filtered_model_names;
    std::set<std::string> all_model_names_set(all_model_names.begin(),
                                              all_model_names.end());
    for (const auto& model_name_json : ddl_payload["modelNames"].GetArray()) {
      std::string model_name = model_name_json.GetString();
      const auto model_name_upper = to_upper(model_name);
      if (all_model_names_set.find(to_upper(model_name_upper)) ==
          all_model_names_set.end()) {
        throw std::runtime_error{"Unable to show model details for model: " +
                                 model_name_upper + ". Model does not exist."};
      }
      filtered_model_names.emplace_back(model_name_upper);
    }
    return filtered_model_names;
  } else {
    return all_model_names;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• /home/jenkins-slave/workspace/core-os-doxygen/Catalog/DdlCommandExecutor.h
• /home/jenkins-slave/workspace/core-os-doxygen/Catalog/DdlCommandExecutor.cpp