An open API service indexing awesome lists of open source software.

https://github.com/fiddler-labs/fiddler-examples


https://github.com/fiddler-labs/fiddler-examples

ai-observability explainable-ai model-monitoring

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README

          


Image of Fiddler logo

***

This repo contains example notebooks and accompanying documentation for using Fiddler.

# Examples

These example notebooks aim to give you a quick start on various Fiddler capabilities using different model tasks, data types, and use cases. They can also serve as a reference guide for setting up the monitoring of your own models in Fiddler.

## Getting Started

Use the projects in this repo to onboard models and data to illustrate ML model and LLM application monitoring, analysis, and protection.
This repo contains the example notebooks listed below. You can launch them in a Google Colab environment using the Colab links.

> **Note:** This repository uses Git Large File Storage (Git LFS) for managing large files.
> Please make sure you have Git LFS installed before cloning this repository.
> You can find installation instructions at [git-lfs.github.com](https://git-lfs.github.com/).
> You can find the file types tracked via GitLFS at the `.gitattributes` file (currently only `.csv` files)

## The Basics

* [LLM - Comparison](https://github.com/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_LLM_Comparison.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_LLM_Comparison.ipynb)
* [LLM - Simple Monitoring Quickstart](https://github.com/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_LLM_Chatbot.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_LLM_Chatbot.ipynb)
* [ML - Simple Monitoring Quickstart](https://github.com/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_Simple_Monitoring.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_Simple_Monitoring.ipynb)
* [Managing Model Versions with Fiddler](https://github.com/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_Model_Versions.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_Model_Versions.ipynb)
* [User-defined Feature Impact Upload](https://github.com/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_User_Defined_Feature_Impact.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_User_Defined_Feature_Impact.ipynb)

## Specific Use Cases

* [Image/Computer Vision Model Monitoring ](https://github.com/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_Image_Monitoring.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_Image_Monitoring.ipynb)
* [NLP Model Monitoring - Multiclass Classification](https://github.com/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_NLP_Multiclass_Monitoring.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_NLP_Multiclass_Monitoring.ipynb)
* [Class Imbalance Drift Detection](https://github.com/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_Imbalanced_Data.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_Imbalanced_Data.ipynb)
* [Ranking Model - Monitoring](https://github.com/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_Ranking_Model.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_Ranking_Model.ipynb)
* [Regression Model - Monitoring](https://github.com/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_Regression_Model.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fiddler-labs/fiddler-examples/blob/main/quickstart/latest/Fiddler_Quickstart_Regression_Model.ipynb)

## Cookbooks

Use-case oriented notebooks that demonstrate end-to-end workflows for solving real AI evaluation and monitoring problems with Fiddler. Each cookbook has a companion guide on the [Fiddler docs site](https://docs.fiddler.ai/developers/cookbooks).

* [RAG Evaluation Fundamentals](https://github.com/fiddler-labs/fiddler-examples/blob/main/cookbooks/Fiddler_Cookbook_RAG_Evaluation_Fundamentals.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fiddler-labs/fiddler-examples/blob/main/cookbooks/Fiddler_Cookbook_RAG_Evaluation_Fundamentals.ipynb) — Evaluate RAG quality with built-in evaluators
* [RAG Experiments at Scale](https://github.com/fiddler-labs/fiddler-examples/blob/main/cookbooks/Fiddler_Cookbook_RAG_Experiments_at_Scale.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fiddler-labs/fiddler-examples/blob/main/cookbooks/Fiddler_Cookbook_RAG_Experiments_at_Scale.ipynb) — Compare RAG pipeline configurations systematically
* [Custom Judge Evaluators](https://github.com/fiddler-labs/fiddler-examples/blob/main/cookbooks/Fiddler_Cookbook_Custom_Judge_Evaluators.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fiddler-labs/fiddler-examples/blob/main/cookbooks/Fiddler_Cookbook_Custom_Judge_Evaluators.ipynb) — Create domain-specific evaluation criteria

## Fiddler Utils Package - Admin Automation Library

The [`fiddler_utils`](./fiddler_utils) package is an admin automation library designed to reduce code duplication across utility scripts and notebooks. While **not part of the official Fiddler SDK**, it is available for both Fiddler field engineers and customers to use and extend.

### Key Capabilities

* **Connection Management** - Multi-instance support for working with multiple Fiddler deployments
* **FQL Utilities** - Parse, validate, and manipulate Fiddler Query Language expressions
* **Schema Validation** - Compare and validate model schemas across instances
* **Asset Management** - Export/import segments, custom metrics, alerts, baselines, charts, and dashboards
* **Model Operations** - Complete model export/import and comprehensive model comparison
* **Environment Analysis** - Project and model inventory with statistics and reporting

### Installation

From the `fiddler-examples` repository root:

```bash
pip install -e .
```

### Quick Example

```python
from fiddler_utils import get_or_init, ModelComparator, SegmentManager

# Initialize connection
get_or_init(url='https://your-instance.fiddler.ai', token='your_token')

# Compare two models
comparator = ModelComparator(model_a, model_b)
result = comparator.compare_all()
print(result.to_markdown())

# Export/import segments
segment_mgr = SegmentManager()
segments = segment_mgr.export_assets(model_id=source_model.id)
segment_mgr.import_assets(target_model_id=target_model.id, assets=segments)
```

### Documentation

See the [fiddler_utils README](./fiddler_utils/README.md) for comprehensive documentation, API reference, and usage examples.

### Integration with Utilities

Several notebooks in the [`misc-utils`](./misc-utils) directory demonstrate `fiddler_utils` features:

* **[export_import_models.ipynb](./misc-utils/export_import_models.ipynb)** - Complete model export/import workflows
* **[export_import_model_assets.ipynb](./misc-utils/export_import_model_assets.ipynb)** - Asset-level transfers between models
* **[compare_models.ipynb](./misc-utils/compare_models.ipynb)** - Comprehensive model comparison
* **[env_stats.ipynb](./misc-utils/env_stats.ipynb)** - Environment reporting and analysis

## Miscellaneous Utilities

The [misc-utils](./misc-utils) directory contains utility notebooks for customer success engineers, field AI engineers, and solution engineers. These notebooks provide tools for various administrative tasks and solutions to common challenges when working with Fiddler deployments. See the [misc-utils README](./misc-utils/README.md) for a detailed catalog of available utilities.

## License

This project is licensed under the MIT license. See the [LICENSE](https://github.com/fiddler-labs/fiddler-examples/blob/main/LICENSE) file for more info.

## Additional Resources

* [Documentation](https://docs.fiddler.ai)
* [Fiddler Blog](https://www.fiddler.ai/blog)
* [Fiddler Resource Library](https://www.fiddler.ai/resources)