opik-optimizer 0.7.0__tar.gz → 0.7.2__tar.gz

opik_optimizer-0.7.2/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: opik_optimizer
+Version: 0.7.2
+Summary: Agent optimization with Opik
+Home-page: https://github.com/comet-ml/opik
+Author: Comet ML
+Author-email: support@comet.com
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.9,<3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: opik>=1.7.17
+Requires-Dist: dspy<3,>=2.6.18
+Requires-Dist: litellm
+Requires-Dist: tqdm
+Requires-Dist: datasets
+Requires-Dist: optuna
+Requires-Dist: pydantic
+Requires-Dist: pandas
+Requires-Dist: hf_xet
+Provides-Extra: dev
+Requires-Dist: adalflow; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-conv; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Opik Optimizer
+
+The Opik Opitmizer can refine your prompts to get better performance
+from your LLMs. You can use a variety of algorithms, including:
+
+* FewShotBayesianOptimizer
+* MiproOptimizer
+* MetaPromptOptimizer
+
+## Quickstart
+
+
+[Open Quickstart Notebook in Colab](https://colab.research.google.com/github/comet-ml/opik/blob/main/sdks/opik_optimizer/notebooks/OpikOptimizerIntro.ipynb)
+
+
+## Setup
+
+1. Configure Opik:
+   ```bash
+   # Install Comet ML CLI
+   pip install opik
+
+   # Configure your API key
+   opik configure
+   # When prompted, enter your Opik API key
+   ```
+
+2. Set up your environment variables:
+   ```bash
+   # OpenAI API key for LLM access
+   export OPENAI_API_KEY=your_openai_api_key
+   ```
+
+3. Install the package:
+   ```bash
+   pip install git+https://github.com/comet-ml/opik#subdirectory=sdks/opik_optimizer
+   ```
+
+You'll need:
+
+1. An LLM model name
+2. An Opik Dataset (or Opik Dataset name)
+3. An Opik Metric (possibly a custom one)
+4. A starting prompt (string)
+
+## Example
+
+We have prepared some sample datasets for testing:
+
+* "tiny-test"
+* "halu-eval-300"
+* "hotpot-300"
+
+You can see how to use those below:
+
+```python
+from opik.evaluation.metrics import LevenshteinRatio
+from opik_optimizer.few_shot_bayesian_optimizer import FewShotBayesianOptimizer
+from opik_optimizer.demo import get_or_create_dataset
+
+from opik_optimizer import (
+    OptimizationConfig,
+    MetricConfig,
+    TaskConfig,
+    from_dataset_field,
+    from_llm_response_text,
+)
+
+hot_pot_dataset = get_or_create_dataset("hotpot-300")
+
+# For chat prompts instruction doesn't need to contain input parameters from dataset examples.
+prompt_instruction = """
+Answer the question.
+"""
+
+initial_prompt_no_examples = [
+    {"role": "system", "content": prompt_instruction},
+    {"role": "user", "content": "{{question}}"},
+]
+
+optimizer = FewShotBayesianOptimizer(
+    model="gpt-4o-mini",
+    project_name="optimize-few-shot-bayesian-hotpot",
+    min_examples=3,
+    max_examples=8,
+    n_threads=16,
+    seed=42,
+)
+
+optimization_config = OptimizationConfig(
+    dataset=hot_pot_dataset,
+    objective=MetricConfig(
+        metric=LevenshteinRatio(),
+        inputs={
+            "output": from_llm_response_text(),
+            "reference": from_dataset_field(name="answer"),
+        },
+    ),
+    task=TaskConfig(
+        instruction_prompt=prompt_instruction,
+        input_dataset_fields=["question"],
+        output_dataset_field="answer",
+        use_chat_prompt=True,
+    ),
+)
+
+result = optimizer.optimize_prompt(optimization_config, n_trials=10)
+print(result)
+```
+
+More examples can be found in the `scripts` folder.
+
+## Installation
+
+```bash
+pip install git+https://github.com/comet-ml/opik#subdirectory=sdks/opik_optimizer
+```
+
+## Development
+
+To use the Opik Optimizer from source:
+
+```bash
+git clone git clone git@github.com:comet-ml/opik
+cd sdks/opik_optimizer
+pip install -e .
+```
+
+## Requirements
+
+- Python 3.10+
+- Opik API key
+- OpenAI API key (or other LLM provider)

{opik_optimizer-0.7.0 → opik_optimizer-0.7.2}/setup.py

@@ -2,14 +2,16 @@ from setuptools import setup, find_packages
 
 setup(
     name="opik_optimizer",
-    version="0.7.0",
+    version="0.7.2",
     description="Agent optimization with Opik",
     author="Comet ML",
-    author_email="info@comet.ml",
+    author_email="support@comet.com",
+    long_description=open("README.md", encoding="utf-8").read(),
+    long_description_content_type='text/markdown',
     url="https://github.com/comet-ml/opik",
     packages=find_packages(where="src"),
     package_dir={"": "src"},
-    python_requires=">=3.9",
+    python_requires=">=3.9,<3.13",
     install_requires=[
         "opik>=1.7.17",
         "dspy>=2.6.18,<3",

opik_optimizer-0.7.2/src/opik_optimizer/__init__.py

@@ -0,0 +1,43 @@
+import importlib.metadata
+import logging
+from .logging_config import setup_logging
+
+__version__ = importlib.metadata.version("opik_optimizer")
+
+# Using WARNING as a sensible default to avoid flooding users with INFO/DEBUG
+setup_logging(level=logging.WARNING)
+
+# Regular imports
+from .mipro_optimizer import MiproOptimizer
+from .base_optimizer import BaseOptimizer
+from .meta_prompt_optimizer import MetaPromptOptimizer
+from .few_shot_bayesian_optimizer import FewShotBayesianOptimizer
+from .optimization_config.configs import (
+    MetricConfig,
+    OptimizationConfig,
+    TaskConfig,
+)
+from .optimization_config.mappers import (
+    from_dataset_field,
+    from_llm_response_text,
+)
+
+from opik.evaluation.models.litellm import warning_filters
+
+warning_filters.add_warning_filters()
+
+from .optimization_result import OptimizationResult
+
+__all__ = [
+    "BaseOptimizer",
+    "FewShotBayesianOptimizer",
+    "MetaPromptOptimizer",
+    "MiproOptimizer",
+    "MetricConfig",
+    "OptimizationConfig",
+    "TaskConfig",
+    "from_dataset_field",
+    "from_llm_response_text",
+    "OptimizationResult",
+    "setup_logging",
+]

{opik_optimizer-0.7.0 → opik_optimizer-0.7.2}/src/opik_optimizer/base_optimizer.py

@@ -4,8 +4,6 @@ import logging
 import time
 
 import litellm
-from opik.evaluation import metrics
-from opik.opik_context import get_current_span_data
 from opik.rest_api.core import ApiError
 
 from pydantic import BaseModel

{opik_optimizer-0.7.0 → opik_optimizer-0.7.2}/src/opik_optimizer/demo/cache.py

@@ -9,6 +9,7 @@ import requests
 NAMED_CACHES = {
     "test": "https://drive.google.com/file/d/1RifNtpN-pl0DW49daRaAMJwW7MCsOh6y/view?usp=sharing",
     "test2": "https://drive.google.com/uc?id=1RifNtpN-pl0DW49daRaAMJwW7MCsOh6y&export=download",
+    "opik-workshop": "https://drive.google.com/file/d/1l0aK6KhDPs2bFsQTkfzvOvfacJlhdmHr/view?usp=sharing",
 }
 CACHE_DIR = os.path.expanduser("~/.litellm_cache")
 

{opik_optimizer-0.7.0 → opik_optimizer-0.7.2}/src/opik_optimizer/few_shot_bayesian_optimizer/few_shot_bayesian_optimizer.py

@@ -85,7 +85,7 @@ class FewShotBayesianOptimizer(base_optimizer.BaseOptimizer):
         split_idx = int(len(dataset) * train_ratio)
         return dataset[:split_idx], dataset[split_idx:]
 
-    def _optimize_prompt(
+    def _optimize_prompt(   
         self,
         dataset: Union[str, Dataset],
         metric_config: MetricConfig,
@@ -171,8 +171,10 @@ class FewShotBayesianOptimizer(base_optimizer.BaseOptimizer):
             n_examples = trial.suggest_int(
                 "n_examples", self.min_examples, self.max_examples
             )
-            available_indices = list(range(len(dataset_items)))
-            example_indices = random.sample(available_indices, n_examples)
+            example_indices = [
+                trial.suggest_categorical(f"example_{i}", list(range(len(dataset_items))))
+                for i in range(n_examples)
+            ]
             trial.set_user_attr("example_indices", example_indices)
 
             instruction = task_config.instruction_prompt

{opik_optimizer-0.7.0 → opik_optimizer-0.7.2}/src/opik_optimizer/optimization_result.py

@@ -99,7 +99,7 @@ class OptimizationResult(pydantic.BaseModel):
             f"\n{separator}",
             f"OPTIMIZATION COMPLETE",
             f"{separator}",
-            f"Optimizer:        {self.details.get('optimizer', type(self).__name__)}",
+            f"Optimizer:        {self.optimizer}",
             f"Model Used:       {model_name} (Temp: {temp_str})",
             f"Metric Evaluated: {self.metric_name}",
             f"Initial Score:    {initial_score_str}",
@@ -138,7 +138,7 @@ class OptimizationResult(pydantic.BaseModel):
 
         table.add_row(
             "Optimizer:",
-            f"[bold]{self.details.get('optimizer', type(self).__name__)}[/bold]",
+            f"[bold]{self.optimizer}[/bold]",
         )
         table.add_row("Model Used:", f"{model_name} ([dim]Temp:[/dim] {temp_str})")
         table.add_row("Metric Evaluated:", f"[bold]{self.metric_name}[/bold]")

opik_optimizer-0.7.2/src/opik_optimizer.egg-info/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: opik_optimizer
+Version: 0.7.2
+Summary: Agent optimization with Opik
+Home-page: https://github.com/comet-ml/opik
+Author: Comet ML
+Author-email: support@comet.com
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.9,<3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: opik>=1.7.17
+Requires-Dist: dspy<3,>=2.6.18
+Requires-Dist: litellm
+Requires-Dist: tqdm
+Requires-Dist: datasets
+Requires-Dist: optuna
+Requires-Dist: pydantic
+Requires-Dist: pandas
+Requires-Dist: hf_xet
+Provides-Extra: dev
+Requires-Dist: adalflow; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-conv; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Opik Optimizer
+
+The Opik Opitmizer can refine your prompts to get better performance
+from your LLMs. You can use a variety of algorithms, including:
+
+* FewShotBayesianOptimizer
+* MiproOptimizer
+* MetaPromptOptimizer
+
+## Quickstart
+
+
+[Open Quickstart Notebook in Colab](https://colab.research.google.com/github/comet-ml/opik/blob/main/sdks/opik_optimizer/notebooks/OpikOptimizerIntro.ipynb)
+
+
+## Setup
+
+1. Configure Opik:
+   ```bash
+   # Install Comet ML CLI
+   pip install opik
+
+   # Configure your API key
+   opik configure
+   # When prompted, enter your Opik API key
+   ```
+
+2. Set up your environment variables:
+   ```bash
+   # OpenAI API key for LLM access
+   export OPENAI_API_KEY=your_openai_api_key
+   ```
+
+3. Install the package:
+   ```bash
+   pip install git+https://github.com/comet-ml/opik#subdirectory=sdks/opik_optimizer
+   ```
+
+You'll need:
+
+1. An LLM model name
+2. An Opik Dataset (or Opik Dataset name)
+3. An Opik Metric (possibly a custom one)
+4. A starting prompt (string)
+
+## Example
+
+We have prepared some sample datasets for testing:
+
+* "tiny-test"
+* "halu-eval-300"
+* "hotpot-300"
+
+You can see how to use those below:
+
+```python
+from opik.evaluation.metrics import LevenshteinRatio
+from opik_optimizer.few_shot_bayesian_optimizer import FewShotBayesianOptimizer
+from opik_optimizer.demo import get_or_create_dataset
+
+from opik_optimizer import (
+    OptimizationConfig,
+    MetricConfig,
+    TaskConfig,
+    from_dataset_field,
+    from_llm_response_text,
+)
+
+hot_pot_dataset = get_or_create_dataset("hotpot-300")
+
+# For chat prompts instruction doesn't need to contain input parameters from dataset examples.
+prompt_instruction = """
+Answer the question.
+"""
+
+initial_prompt_no_examples = [
+    {"role": "system", "content": prompt_instruction},
+    {"role": "user", "content": "{{question}}"},
+]
+
+optimizer = FewShotBayesianOptimizer(
+    model="gpt-4o-mini",
+    project_name="optimize-few-shot-bayesian-hotpot",
+    min_examples=3,
+    max_examples=8,
+    n_threads=16,
+    seed=42,
+)
+
+optimization_config = OptimizationConfig(
+    dataset=hot_pot_dataset,
+    objective=MetricConfig(
+        metric=LevenshteinRatio(),
+        inputs={
+            "output": from_llm_response_text(),
+            "reference": from_dataset_field(name="answer"),
+        },
+    ),
+    task=TaskConfig(
+        instruction_prompt=prompt_instruction,
+        input_dataset_fields=["question"],
+        output_dataset_field="answer",
+        use_chat_prompt=True,
+    ),
+)
+
+result = optimizer.optimize_prompt(optimization_config, n_trials=10)
+print(result)
+```
+
+More examples can be found in the `scripts` folder.
+
+## Installation
+
+```bash
+pip install git+https://github.com/comet-ml/opik#subdirectory=sdks/opik_optimizer
+```
+
+## Development
+
+To use the Opik Optimizer from source:
+
+```bash
+git clone git clone git@github.com:comet-ml/opik
+cd sdks/opik_optimizer
+pip install -e .
+```
+
+## Requirements
+
+- Python 3.10+
+- Opik API key
+- OpenAI API key (or other LLM provider)

opik_optimizer-0.7.0/PKG-INFO

@@ -1,35 +0,0 @@
-Metadata-Version: 2.4
-Name: opik_optimizer
-Version: 0.7.0
-Summary: Agent optimization with Opik
-Home-page: https://github.com/comet-ml/opik
-Author: Comet ML
-Author-email: info@comet.ml
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Requires-Python: >=3.9
-License-File: LICENSE
-Requires-Dist: opik>=1.7.17
-Requires-Dist: dspy<3,>=2.6.18
-Requires-Dist: litellm
-Requires-Dist: tqdm
-Requires-Dist: datasets
-Requires-Dist: optuna
-Requires-Dist: pydantic
-Requires-Dist: pandas
-Requires-Dist: hf_xet
-Provides-Extra: dev
-Requires-Dist: adalflow; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-conv; extra == "dev"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary

opik_optimizer-0.7.0/src/opik_optimizer/__init__.py

@@ -1,65 +0,0 @@
-import importlib.metadata
-import logging
-from .logging_config import setup_logging
-
-__version__ = importlib.metadata.version("opik_optimizer")
-
-# Using WARNING as a sensible default to avoid flooding users with INFO/DEBUG
-setup_logging(level=logging.WARNING)
-
-
-# Lazy imports to avoid circular dependencies
-def __getattr__(name):
-    if name == "MiproOptimizer":
-        from .mipro_optimizer import MiproOptimizer
-
-        return MiproOptimizer
-    elif name == "BaseOptimizer":
-        from .base_optimizer import BaseOptimizer
-
-        return BaseOptimizer
-    elif name == "MetaPromptOptimizer":
-        from .meta_prompt_optimizer import MetaPromptOptimizer
-
-        return MetaPromptOptimizer
-    elif name == "FewShotBayesianOptimizer":
-        from .few_shot_bayesian_optimizer import FewShotBayesianOptimizer
-
-        return FewShotBayesianOptimizer
-    elif name in ["MetricConfig", "OptimizationConfig", "TaskConfig"]:
-        from .optimization_config.configs import (
-            MetricConfig,
-            OptimizationConfig,
-            TaskConfig,
-        )
-
-        return locals()[name]
-    elif name in ["from_dataset_field", "from_llm_response_text"]:
-        from .optimization_config.mappers import (
-            from_dataset_field,
-            from_llm_response_text,
-        )
-
-        return locals()[name]
-    raise AttributeError(f"module 'opik_optimizer' has no attribute '{name}'")
-
-
-from opik.evaluation.models.litellm import warning_filters
-
-warning_filters.add_warning_filters()
-
-from .optimization_result import OptimizationResult
-
-__all__ = [
-    "BaseOptimizer",
-    "FewShotBayesianOptimizer",
-    "MetaPromptOptimizer",
-    "MiproOptimizer",
-    "MetricConfig",
-    "OptimizationConfig",
-    "TaskConfig",
-    "from_dataset_field",
-    "from_llm_response_text",
-    "OptimizationResult",
-    "setup_logging",
-]

opik_optimizer-0.7.0/src/opik_optimizer.egg-info/PKG-INFO

@@ -1,35 +0,0 @@
-Metadata-Version: 2.4
-Name: opik_optimizer
-Version: 0.7.0
-Summary: Agent optimization with Opik
-Home-page: https://github.com/comet-ml/opik
-Author: Comet ML
-Author-email: info@comet.ml
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Requires-Python: >=3.9
-License-File: LICENSE
-Requires-Dist: opik>=1.7.17
-Requires-Dist: dspy<3,>=2.6.18
-Requires-Dist: litellm
-Requires-Dist: tqdm
-Requires-Dist: datasets
-Requires-Dist: optuna
-Requires-Dist: pydantic
-Requires-Dist: pandas
-Requires-Dist: hf_xet
-Provides-Extra: dev
-Requires-Dist: adalflow; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-conv; extra == "dev"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary