warn for invalid keys for components

changelog/6966.improvement.md

@@ -0,0 +1 @@
+Added warning for when an option is provided for a component that is not listed as a key in the defaults for that component.

rasa/nlu/components.py

@@ -91,6 +91,34 @@ def validate_requirements(component_names: List[Optional[Text]]) -> None:
         )
 
 
+def validate_component_keys(pipeline: List["Component"]) -> None:
+    """Validates that all keys for a component are valid.
+
+    Raises:
+        InvalidConfigError: If any component has a key specified that is not used
+            by the component class, it is likely a mistake in the pipeline
+
+    Args:
+        pipeline: The list of components in the piopeline
+    """
+    from rasa.nlu import registry
+
+    for component in pipeline:
+        component_name = component.get("name")
+        component_class = registry.get_component_class(component_name)
+        allowed_keys = set(component_class.defaults.keys())
+        provided_keys = set(component.keys())
+        provided_keys.remove("name")
+        listseperator = "\n- "
+        for key in provided_keys:
+            if key not in allowed_keys:
+                rasa.shared.utils.io.raise_warning(
+                    f"You have provided an invalid key `{key}` for component `{component_name}` in your pipeline. "
+                    f"Valid options for `{component_name}` are:\n- "
+                    f"{listseperator.join(allowed_keys)}"
+                )
+
+
 def validate_empty_pipeline(pipeline: List["Component"]) -> None:
     """Ensures the pipeline is not empty.
 

rasa/nlu/model.py

@@ -153,6 +153,7 @@ def __init__(
         # required packages are available
         if not self.skip_validation:
             components.validate_requirements(cfg.component_names)
+            components.validate_component_keys(cfg.pipeline)
 
         # build pipeline
         self.pipeline = self._build_pipeline(cfg, component_builder)
@@ -338,6 +339,7 @@ def create(
         # lets check if all required packages are available
         if not skip_validation:
             components.validate_requirements(model_metadata.component_classes)
+            components.validate_component_keys(model_metadata)
 
         for i in range(model_metadata.number_of_components):
             component_meta = model_metadata.for_component(i)

tests/nlu/test_components.py

@@ -200,3 +200,17 @@ async def test_validate_requirements_raises_exception_on_component_without_name(
         await train(
             _config, data="./data/examples/rasa/demo-rasa.json", path=str(tmp_path),
         )
+
+
+async def test_validate_component_keys_raises_warning_on_invalid_key(tmp_path: Path,):
+    _config = RasaNLUModelConfig(
+        # config with a component that does not have a `name` property
+        {"pipeline": [{"name": "WhitespaceTokenizer", "confidence_threshold": 0.7}]}
+    )
+
+    with pytest.warns(UserWarning) as record:
+        await train(
+            _config, data="./data/examples/rasa/demo-rasa.json", path=str(tmp_path),
+        )
+
+    assert "You have provided an invalid key" in record[0].message.args[0]