aiqtoolkit 1.2.0rc4__py3-none-any.whl → 1.2rc9__py3-none-any.whl

aiq/cli/__init__.py

@@ -1,14 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025, 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.

aiq/cli/cli_utils/config_override.py

@@ -1,231 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025, 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.
-
-import logging
-import tempfile
-from copy import deepcopy
-from pathlib import Path
-from typing import Any
-
-import click
-import yaml
-
-from aiq.utils.data_models.schema_validator import validate_yaml
-from aiq.utils.io.yaml_tools import yaml_load
-
-logger = logging.getLogger(__name__)
-
-
-class _Placeholder:
-    """Placeholder class to represent a value that is not set yet."""
-    pass
-
-
-class LayeredConfig:
-
-    def __init__(self, base_config: dict[str, Any]):
-        if not isinstance(base_config, dict):
-            raise ValueError("Base config must be a dictionary")
-        self.base_config = deepcopy(base_config)
-        self.overrides: dict[str, Any] = {}
-        self._effective_config: dict[str, Any] | None = None
-
-    def validate_path(self, path: str) -> None:
-        """Validate if a path exists in base config"""
-        parts = path.split('.')
-        current = self.base_config
-
-        for i, part in enumerate(parts):
-            if not isinstance(current, dict):
-                current_path = '.'.join(parts[:i])
-                raise click.BadParameter(f"Cannot navigate through non-dictionary value at '{current_path}'")
-            if part not in current:
-                if i == len(parts) - 1:
-                    current[part] = _Placeholder()
-                else:
-                    current[part] = {}
-
-            current = current[part]
-
-    def set_override(self, path: str, value: str) -> None:
-        """Set an override value with type conversion based on original config value.
-
-        Args:
-            path: Configuration path in dot notation (e.g., "llms.nim_llm.temperature")
-            value: String value from CLI to override with
-
-        Raises:
-            click.BadParameter: If path doesn't exist or type conversion fails
-            Exception: For other unexpected errors
-        """
-        try:
-            # Validate path exists in config
-            self.validate_path(path)
-
-            # Get original value to determine type
-            original_value = self.get_value(path)
-
-            # Convert string value to appropriate type
-            try:
-                if isinstance(original_value, bool):
-                    lower_value = value.lower().strip()
-                    if lower_value not in ['true', 'false']:
-                        raise ValueError(f"Boolean value must be 'true' or 'false', got '{value}'")
-                    value = lower_value == 'true'
-                elif isinstance(original_value, (int, float)):
-                    value = type(original_value)(value)
-                elif isinstance(original_value, list):
-                    value = [v.strip() for v in value.split(',')]
-                elif isinstance(original_value, Path):
-                    value = Path(value)
-            except (ValueError, TypeError) as e:
-                raise click.BadParameter(f"Type mismatch for '{path}': expected {type(original_value).__name__}, "
-                                         f"got '{value}' ({type(value).__name__}). Error: {str(e)}")
-
-            # Store converted value
-            self.overrides[path] = value
-            self._effective_config = None
-
-            log_msg = f"Successfully set override for {path} with value: {value}"
-            if not isinstance(original_value, _Placeholder):
-                log_msg += f" with type {type(value)})"
-
-            logger.info(log_msg)
-
-        except Exception as e:
-            logger.error("Failed to set override for %s: %s", path, str(e))
-            raise
-
-    def get_value(self, path: str) -> Any:
-        """Get value with better error messages"""
-        try:
-            if path in self.overrides:
-                return self.overrides[path]
-
-            parts = path.split('.')
-            current = self.base_config
-
-            for i, part in enumerate(parts):
-                if not isinstance(current, dict):
-                    current_path = '.'.join(parts[:i])
-                    raise click.BadParameter(f"Cannot access '{path}': '{current_path}' is not a dictionary")
-                if part not in current:
-                    raise click.BadParameter(f"Path '{path}' not found: '{part}' does not exist")
-                current = current[part]
-
-            return current
-
-        except Exception as e:
-            logger.error("Error accessing path %s: %s", path, e)
-            raise
-
-    def _update_config_value(self, config: dict[str, Any], path: str, value: Any) -> None:
-        """Update a single value in the config dictionary at the specified path.
-
-        Args:
-            config: The configuration dictionary to update
-            path: String representing the path to the value using dot notation (e.g. "llms.nim_llm.temperature")
-            value: The new value to set at the specified path
-
-        Example:
-            If config is {"llms": {"nim_llm": {"temperature": 0.5}}}
-            and path is "llms.nim_llm.temperature" with value 0.7,
-            this will update config to {"llms": {"nim_llm": {"temperature": 0.7}}}
-        """
-        parts = path.split('.')
-        current = config
-        # Navigate through nested dictionaries until reaching the parent of target
-        for part in parts[:-1]:
-            current = current[part]
-        # Update the value at the target location
-        current[parts[-1]] = value
-
-    def get_effective_config(self) -> dict[str, Any]:
-        """Get the configuration with all overrides applied.
-
-        Creates a new configuration dictionary by applying all stored overrides
-        to a deep copy of the base configuration. Caches the result to avoid
-        recomputing unless overrides change.
-
-        Returns:
-            Dict containing the full configuration with all overrides applied
-
-        Note:
-            The configuration is cached in self._effective_config and only
-            recomputed when new overrides are added via set_override()
-        """
-        # Return cached config if available
-        if self._effective_config is not None:
-            return self._effective_config
-
-        # Create deep copy to avoid modifying base config
-        config = deepcopy(self.base_config)
-
-        # Apply each override to the config copy
-        for path, value in self.overrides.items():
-            self._update_config_value(config, path, value)
-
-        # Return the result
-        self._effective_config = config
-        return config
-
-
-def load_and_override_config(config_file: Path, overrides: tuple[tuple[str, str], ...]) -> dict[str, Any]:
-    """Load config file and apply any overrides"""
-
-    # Load the base config
-    base_config = yaml_load(config_file)
-
-    # Create layered config
-    config = LayeredConfig(base_config)
-
-    # Apply overrides if any
-    if overrides:
-        for param_path, value in overrides:
-            config.set_override(param_path, value)
-
-        effective_config = config.get_effective_config()
-
-        # Second validation is necessary to ensure overrides haven't created an invalid config
-        # For example, overrides might break required relationships between fields
-        with tempfile.NamedTemporaryFile(mode='w', suffix='.yml', delete=False) as tmp:
-            yaml.safe_dump(effective_config, tmp)
-            tmp_path = Path(tmp.name)
-
-        try:
-            # Validate using the temporary file
-            validate_yaml(None, None, tmp_path)
-            # If validation succeeds, print the config
-            logger.info(
-                "\n\nConfiguration after overrides:\n\n%s",
-                yaml.dump(effective_config, default_flow_style=False),
-            )
-        except Exception as e:
-            logger.exception("Modified configuration failed validation: %s", e, exc_info=True)
-            raise click.BadParameter(f"Modified configuration failed validation: {str(e)}")
-        finally:
-            # Clean up the temporary file
-            tmp_path.unlink()
-
-    return config.get_effective_config()
-
-
-def add_override_option(command):
-    """Decorator to add override option to a command"""
-    return click.option(
-        '--override',
-        type=(str, str),
-        multiple=True,
-        help="Override config values using dot notation (e.g., --override llms.nim_llm.temperature 0.7)")(command)

aiq/cli/cli_utils/validation.py

@@ -1,37 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025, 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.
-
-from pathlib import Path
-
-import click
-import yaml
-
-from aiq.data_models.config import AIQConfig
-
-
-def validate_config(config_file: Path) -> AIQConfig:
-    """Validate configuration file and return parsed config"""
-    try:
-        from aiq.runtime.loader import load_config
-
-        # Load using the AIQ Toolkit loader functions. This performs validation
-        config = load_config(config_file)
-
-        return config
-
-    except yaml.YAMLError as e:
-        raise click.ClickException(f"Invalid YAML format: {str(e)}")
-    except Exception as e:
-        raise click.ClickException(f"Validation error: {str(e)}")

aiq/cli/commands/configure/channel/add.py

@@ -1,28 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2025, 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.
-
-import logging
-
-import click
-
-logger = logging.getLogger(__name__)
-
-
-@click.group(name=__name__, invoke_without_command=True, help="Utility to add an AIQ Toolkit remote registry channel.")
-@click.argument("channel_type", type=str)
-def add(channel_type: str) -> None:
-    from aiq.utils.settings.global_settings import add_channel_interative
-
-    add_channel_interative(channel_type=channel_type)

aiq/cli/commands/configure/channel/channel.py

@@ -1,36 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2025, 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.
-
-import logging
-
-import click
-
-from aiq.cli.commands.configure.channel.add import add
-from aiq.cli.commands.configure.channel.remove import remove
-from aiq.cli.commands.configure.channel.update import update
-
-logger = logging.getLogger(__name__)
-
-
-@click.group(name=__name__,
-             invoke_without_command=False,
-             help="Utility to configure AIQ Toolkit remote registry channels.")
-def channel(**kwargs):
-    pass
-
-
-channel.add_command(add, "add")
-channel.add_command(remove, "remove")
-channel.add_command(update, "update")

aiq/cli/commands/configure/channel/remove.py

@@ -1,30 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2025, 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.
-
-import logging
-
-import click
-
-logger = logging.getLogger(__name__)
-
-
-@click.group(name=__name__,
-             invoke_without_command=True,
-             help="Utility to remove a configured AIQ Toolkit remote registry channel.")
-@click.argument("channel", type=str)
-def remove(channel: str):
-    from aiq.utils.settings.global_settings import remove_channel_interactive
-
-    remove_channel_interactive(channel_name=channel)

aiq/cli/commands/configure/channel/update.py

@@ -1,30 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2025, 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.
-
-import logging
-
-import click
-
-logger = logging.getLogger(__name__)
-
-
-@click.group(name="update",
-             invoke_without_command=True,
-             help="Utility to update an AIQ Toolkit remote registry channel's settings.")
-@click.argument("channel", type=str)
-def update(channel):
-    from aiq.utils.settings.global_settings import update_channel_interactive
-
-    update_channel_interactive(channel_name=channel)

aiq/cli/commands/configure/configure.py

@@ -1,33 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2025, 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.
-
-import logging
-
-import click
-
-from aiq.cli.commands.configure.channel.channel import channel
-
-logger = logging.getLogger(__name__)
-
-
-@click.group(name=__name__, invoke_without_command=False, help="Configure AIQ Toolkit developer preferences.")
-def configure_command(**kwargs):
-    """
-    Publish AIQ Toolkit artifacts with the specified configuration
-    """
-    pass
-
-
-configure_command.add_command(channel, name="channel")

aiq/cli/commands/evaluate.py

@@ -1,139 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025, 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.
-
-import asyncio
-import logging
-from pathlib import Path
-
-import click
-
-from aiq.eval.evaluate import EvaluationRun
-from aiq.eval.evaluate import EvaluationRunConfig
-
-logger = logging.getLogger(__name__)
-
-
-@click.group(name=__name__, invoke_without_command=True, help="Evaluate a workflow with the specified dataset.")
-@click.option(
-    "--config_file",
-    type=click.Path(exists=True, file_okay=True, dir_okay=False, path_type=Path),
-    required=True,
-    help="A JSON/YAML file that sets the parameters for the workflow and evaluation.",
-)
-@click.option(
-    "--dataset",
-    type=click.Path(exists=True, file_okay=True, dir_okay=False, path_type=Path),
-    required=False,
-    help="A json file with questions and ground truth answers. This will override the dataset path in the config file.",
-)
-@click.option(
-    "--result_json_path",
-    type=str,
-    default="$",
-    help=("A JSON path to extract the result from the workflow. Use this when the workflow returns "
-          "multiple objects or a dictionary. For example, '$.output' will extract the 'output' field "
-          "from the result."),
-)
-@click.option(
-    "--skip_workflow",
-    is_flag=True,
-    default=False,
-    help="Skip the workflow execution and use the provided dataset for evaluation. "
-    "In this case the dataset should have the 'generated_' columns.",
-)
-@click.option(
-    "--skip_completed_entries",
-    is_flag=True,
-    default=False,
-    help="Skip the dataset entries that have a generated answer.",
-)
-@click.option(
-    "--endpoint",
-    type=str,
-    default=None,
-    help="Use endpoint for running the workflow. Example: http://localhost:8000/generate",
-)
-@click.option(
-    "--endpoint_timeout",
-    type=int,
-    default=300,
-    help="HTTP response timeout in seconds. Only relevant if endpoint is specified.",
-)
-@click.option(
-    "--reps",
-    type=int,
-    default=1,
-    help="Number of repetitions for the evaluation.",
-)
-@click.option(
-    "--override",
-    type=(str, str),
-    multiple=True,
-    help="Override config values using dot notation (e.g., --override llms.nim_llm.temperature 0.7)",
-)
-@click.pass_context
-def eval_command(ctx, **kwargs) -> None:
-    """ Evaluate datasets with the specified mechanism"""
-    pass
-
-
-async def run_and_evaluate(config: EvaluationRunConfig):
-    # Run evaluation
-    eval_runner = EvaluationRun(config=config)
-    await eval_runner.run_and_evaluate()
-
-
-@eval_command.result_callback(replace=True)
-def process_aiq_eval(
-    processors,  # pylint: disable=unused-argument
-    *,
-    config_file: Path,
-    dataset: Path,
-    result_json_path: str,
-    skip_workflow: bool,
-    skip_completed_entries: bool,
-    endpoint: str,
-    endpoint_timeout: int,
-    reps: int,
-    override: tuple[tuple[str, str], ...],
-):
-    """
-    Process the eval command and execute the evaluation. Here the config_file, if provided, is checked for its existence
-    on disk.
-    """
-    # Cannot skip_workflow if endpoint is specified
-    if skip_workflow and endpoint:
-        raise click.UsageError("The options '--skip_workflow' and '--endpoint' are mutually exclusive. "
-                               "Please use only one of them.")
-
-    # You cannot run multiple repetitions if you are skipping the workflow or skipping completed entries
-    if reps > 1 and (skip_workflow or skip_completed_entries):
-        raise click.UsageError("The options '--reps' and '--skip_workflow' or '--skip_completed_entries' are mutually "
-                               "exclusive. You cannot run multiple repetitions if you are skipping the workflow or "
-                               "have a partially completed dataset.")
-
-    # Create the configuration object
-    config = EvaluationRunConfig(
-        config_file=config_file,
-        dataset=str(dataset) if dataset else None,
-        result_json_path=result_json_path,
-        skip_workflow=skip_workflow,
-        skip_completed_entries=skip_completed_entries,
-        endpoint=endpoint,
-        endpoint_timeout=endpoint_timeout,
-        reps=reps,
-        override=override,
-    )
-    asyncio.run(run_and_evaluate(config))

aiq/cli/commands/info/__init__.py

@@ -1,14 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2025, 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.

aiq/cli/commands/info/info.py

@@ -1,39 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2025, 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.
-
-import logging
-
-import click
-
-from aiq.cli.commands.info.list_channels import list_channels
-from aiq.cli.commands.info.list_components import list_components
-from aiq.cli.commands.info.list_mcp import list_mcp
-
-logger = logging.getLogger(__name__)
-
-
-@click.group(name=__name__,
-             invoke_without_command=False,
-             help="Provide information about the local AIQ Toolkit environment.")
-def info_command(**kwargs):
-    """
-    Provide information about the local AIQ Toolkit environment.
-    """
-    pass
-
-
-info_command.add_command(list_components, name="components")
-info_command.add_command(list_channels, "channels")
-info_command.add_command(list_mcp, "mcp")

aiq/cli/commands/info/list_channels.py

@@ -1,32 +0,0 @@
-# SPDX-FileCopyrightText: Copyright (c) 2025, 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.
-
-import logging
-
-import click
-
-logger = logging.getLogger(__name__)
-
-
-@click.group(name=__name__, invoke_without_command=True, help="List the configured remote registry channels.")
-@click.option("-t", "--type", "channel_type", type=str, required=False, help=("Filter the results by channel type."))
-def list_channels(channel_type: str):
-    from aiq.settings.global_settings import GlobalSettings
-
-    settings = GlobalSettings().get()
-    try:
-        settings.print_channel_settings(channel_type=channel_type)
-    except Exception as e:
-        logger.exception("Error listing channels: %s", e, exc_info=True)