chore: clean up ftue with default model provider errors (#66)

* clean up ftue with default model provider errors

* need to return an array though empty in _resolve_model_providers

* Spread err logs to multiple lines

Author: nabinchha

src/data_designer/config/default_model_settings.py

@@ -4,6 +4,7 @@
 
 from functools import lru_cache
 import logging
+import os
 from pathlib import Path
 from typing import Any, Literal, Optional
 
@@ -15,7 +16,6 @@
     PREDEFINED_PROVIDERS,
     PREDEFINED_PROVIDERS_MODEL_MAP,
 )
-from .utils.info import ConfigBuilderInfo, InfoType, InterfaceInfo
 from .utils.io_helpers import load_config_file, save_config_file
 
 logger = logging.getLogger(__name__)
@@ -78,6 +78,14 @@ def get_default_model_configs() -> list[ModelConfig]:
     return []
 
 
+def get_defaul_model_providers_missing_api_keys() -> list[str]:
+    missing_api_keys = []
+    for predefined_provider in PREDEFINED_PROVIDERS:
+        if os.environ.get(predefined_provider["api_key"]) is None:
+            missing_api_keys.append(predefined_provider["api_key"])
+    return missing_api_keys
+
+
 def get_default_providers() -> list[ModelProvider]:
     config_dict = _get_default_providers_file_content(MODEL_PROVIDERS_FILE_PATH)
     if "providers" in config_dict:
@@ -91,21 +99,17 @@ def get_default_provider_name() -> Optional[str]:
 
 def resolve_seed_default_model_settings() -> None:
     if not MODEL_CONFIGS_FILE_PATH.exists():
-        logger.info(
+        logger.debug(
             f"🍾 Default model configs were not found, so writing the following to {str(MODEL_CONFIGS_FILE_PATH)!r}"
         )
-        config_builder_info = ConfigBuilderInfo(model_configs=get_builtin_model_configs())
-        config_builder_info.display(info_type=InfoType.MODEL_CONFIGS)
         save_config_file(
             MODEL_CONFIGS_FILE_PATH, {"model_configs": [mc.model_dump() for mc in get_builtin_model_configs()]}
         )
 
     if not MODEL_PROVIDERS_FILE_PATH.exists():
-        logger.info(
+        logger.debug(
             f"🪄  Default model providers were not found, so writing the following to {str(MODEL_PROVIDERS_FILE_PATH)!r}"
         )
-        interface_info = InterfaceInfo(model_providers=get_builtin_model_providers())
-        interface_info.display(info_type=InfoType.MODEL_PROVIDERS)
         save_config_file(
             MODEL_PROVIDERS_FILE_PATH, {"providers": [p.model_dump() for p in get_builtin_model_providers()]}
         )

src/data_designer/interface/data_designer.py

@@ -9,6 +9,7 @@
 from data_designer.config.analysis.dataset_profiler import DatasetProfilerResults
 from data_designer.config.config_builder import DataDesignerConfigBuilder
 from data_designer.config.default_model_settings import (
+    get_defaul_model_providers_missing_api_keys,
     get_default_model_configs,
     get_default_provider_name,
     get_default_providers,
@@ -26,8 +27,9 @@
     MANAGED_ASSETS_PATH,
     MODEL_CONFIGS_FILE_PATH,
     MODEL_PROVIDERS_FILE_PATH,
+    PREDEFINED_PROVIDERS,
 )
-from data_designer.config.utils.info import InterfaceInfo
+from data_designer.config.utils.info import InfoType, InterfaceInfo
 from data_designer.config.utils.io_helpers import write_seed_dataset
 from data_designer.config.utils.misc import can_run_data_designer_locally
 from data_designer.engine.analysis.dataset_profiler import (
@@ -103,7 +105,7 @@ def __init__(
         self._artifact_path = Path(artifact_path) if artifact_path is not None else Path.cwd() / "artifacts"
         self._buffer_size = DEFAULT_BUFFER_SIZE
         self._managed_assets_path = Path(managed_assets_path or MANAGED_ASSETS_PATH)
-        self._model_providers = model_providers or self.get_default_model_providers()
+        self._model_providers = self._resolve_model_providers(model_providers)
         self._model_provider_registry = resolve_model_provider_registry(
             self._model_providers, get_default_provider_name()
         )
@@ -151,7 +153,7 @@ def info(self) -> InterfaceInfo:
         Returns:
             InterfaceInfo object with information about the Data Designer interface.
         """
-        return InterfaceInfo(model_providers=self._model_providers)
+        return self._get_interface_info(self._model_providers)
 
     def create(
         self,
@@ -307,6 +309,22 @@ def set_buffer_size(self, buffer_size: int) -> None:
             raise InvalidBufferValueError("Buffer size must be greater than 0.")
         self._buffer_size = buffer_size
 
+    def _resolve_model_providers(self, model_providers: list[ModelProvider] | None) -> list[ModelProvider]:
+        if model_providers is None:
+            if can_run_data_designer_locally():
+                model_providers = get_default_providers()
+                missing_api_keys = get_defaul_model_providers_missing_api_keys()
+                if len(missing_api_keys) == len(PREDEFINED_PROVIDERS):
+                    logger.warning(
+                        "🚨 You are trying to use a default model provider but your API keys are missing."
+                        "\n\t\t\tSet the API key for the default providers you intend to use and re-initialize the Data Designer object."
+                        "\n\t\t\tAlternatively, you can provide your own model providers during Data Designer object initialization."
+                        "\n\t\t\tSee https://nvidia-nemo.github.io/DataDesigner/models/model-providers/ for more information."
+                    )
+                    self._get_interface_info(model_providers).display(InfoType.MODEL_PROVIDERS)
+                return model_providers
+        return model_providers or []
+
     def _create_dataset_builder(
         self, config_builder: DataDesignerConfigBuilder, resource_provider: ResourceProvider
     ) -> ColumnWiseDatasetBuilder:
@@ -349,3 +367,6 @@ def _create_resource_provider(
                 )
             ),
         )
+
+    def _get_interface_info(self, model_providers: list[ModelProvider]) -> InterfaceInfo:
+        return InterfaceInfo(model_providers=model_providers)

tests/config/test_default_model_settings.py

@@ -11,6 +11,7 @@
 from data_designer.config.default_model_settings import (
     get_builtin_model_configs,
     get_builtin_model_providers,
+    get_defaul_model_providers_missing_api_keys,
     get_default_inference_parameters,
     get_default_model_configs,
     get_default_provider_name,
@@ -146,3 +147,9 @@ def test_resolve_seed_default_model_settings(tmp_path: Path):
             with open(model_providers_file_path) as f:
                 providers_data = yaml.safe_load(f)
             assert providers_data == {"providers": [p.model_dump() for p in get_builtin_model_providers()]}
+
+
+@patch("data_designer.config.default_model_settings.os.environ.get")
+def test_get_default_model_providers_missing_api_keys(mock_environ_get):
+    mock_environ_get.return_value = None
+    assert get_defaul_model_providers_missing_api_keys() == ["NVIDIA_API_KEY", "OPENAI_API_KEY"]