Welcome to Olive’s documentation!

Important

Olive is currently under pre-release. There will be constant updates and improvements to the functions and usage. Feel free to give feedback and suggestions to us.

This document introduces Olive and provides some examples to get you started.

OVERVIEW

• Olive
• Quick Tour
• Olive Options

GET STARTED

• Installation
• Quickstart Examples

EXAMPLES

• Examples

OLIVE COMMANDS

• Run
• Finetune
• Auto-Optimization
• Quantization
• Capture Onnx Graph
• Generate Adapters
• Convert Adapters
• Tune OnnxRuntime Session Params
• Generate Cost Model for Model Splitting
• Qualcomm SDK
• AzureML
• Shared Cache
• Providing Input Models
• Model Script File Information

FEATURES

• Azure ML integration
• Huggingface Integration
• LoRA Adapters
• Packaging Olive artifacts
• Shared Cache
• Remote Workflow
• Model Conversions
• Model Quantizations
• Model Transformations and Optimizations

EXTENDING OLIVE

• Design
• How to add new optimization Pass
• Custom Scripts

TUTORIALS

• How To Configure System
• How To Configure Metric
• How To Configure Auto Optimizer
• How To Configure Pass
• How To Configure Data
• How To Set Model Path
• Advanced User Tour
• Self-hosted Kubernetes cluster
• Azure ML scripts

API REFERENCE

• OliveModels
• ResourcePath
• OliveSystems
• OliveEvaluator
• Metric
• SearchAlgorithms
• Engine
• Passes