VIPR Framework Documentation

Welcome to the VIPR Framework documentation.

Getting Started

• Web App Inference Flow
  • Overview
  • Architecture Overview
  • Complete Inference Flow
  • Detailed Steps
  • Configuration Formats

Setup & Configuration

• Authentication
  • vipr-gid-plugin (private)
• VIPR Framework - CLI Installation
  • Table of Contents
  • Prerequisites
  • Installation
  • Environment Setup
  • Verify Installation
  • Quick Start Example
• Docker Deployment
  • Quick Start
  • Services
  • Common Tasks
  • Troubleshooting
  • Image Sources

CLI Usage

• VIPR Framework - CLI Reference
  • Table of Contents
  • Command Overview
  • Inference Commands
  • Registry Commands
  • Plugin Commands
  • Help Commands
  • Configuration
  • Common Workflows

Plugins

• VIPR Plugins
  • Built-in Plugins
  • Domain-Specific Plugins
  • Plugin Management
  • Developing Plugins
  • Plugin Architecture
• API Plugin Documentation
  • Overview
  • Documentation Structure
  • Architecture
  • Core Components
  • Environment Variables
  • See Also
• API Plugin - Usage Guide
  • Table of Contents
  • Usage Examples
  • Hook Integration
  • CLI Commands
  • Best Practices
  • Integration Examples
  • See Also
• Matplotlib Visualization Configuration
  • Scope
  • YAML Schema
  • Merge Rules
  • diagram_id vs Filename
  • Typical IDs (Reflectometry)
  • Notes
• HTTP API Routes
  • Summary
  • Auto-generated Cement Routes
  • Manual FastAPI Routes
• Discovery Plugin Documentation
  • Overview
  • Architecture
  • Available Decorators
  • Usage Examples
  • CLI Commands
  • API Integration
  • Plugin Filtering
  • Integration with Dynamic Hooks Extension
  • Registry Data Structure
  • Best Practices
  • Programmatic Access
  • Configuration Generation
  • See Also
• HuggingFace Plugin
  • Overview
  • Configuration
  • Model Storage
  • CLI Commands
  • Adding Custom Models
  • Supported Weight Formats
  • Example: Multiple Models
  • Download Behavior
  • See Also
• Inference Plugin Documentation
  • Overview
  • Data Flow
  • DataSet Transfer Object
  • Architecture
  • Extension Points
  • Hook and Filter System
  • Configuration
  • Usage Example
• Normalizers Plugin Documentation
  • Overview
  • Available Normalizers
  • Architecture
  • Configuration
  • Usage Example
  • Choosing a Normalizer
  • See Also
• Performance Monitoring Plugin
  • Overview
  • How It Works
  • Usage
  • Measurement Scope
  • Configuration
  • See Also
• Filter Documentation
  • Quick Start for Reflectometry
  • Available Filters
  • Filter Chaining
  • Practical Examples
  • Best Practices
• Reflectometry Plugin Documentation
  • Overview
  • Plugin Architecture
  • Framework Integration Points
  • Registered Components
  • Environment Configuration
  • Installation
  • Quick Start
  • Documentation
• GID Plugin Documentation
  • Overview
  • Registered Components
  • Quickstart
  • Documentation

Extensions

• Strict Hook/Filter Registration Extension
  • Overview
  • Why Strict-by-Default?
  • Configuration
  • Usage
  • Error Messages
  • Integration with Dynamic Hooks/Filters
  • Use Cases
  • Troubleshooting
  • Best Practices
  • Technical Details
  • Migration Guide
  • See Also
• Dynamic Hooks and Filters Extension
  • Overview
  • Configuration Model
  • Required Fields
  • Examples
  • Security and Validation
  • Plugin Availability Notes
  • Troubleshooting
  • Best Practices
  • See Also

API Reference

• vipr
  • vipr package
• vipr_api
  • vipr_api package
• vipr_reflectometry
  • vipr_reflectometry package

System Overview

VIPR is a modular ML framework with:

• vipr-frontend - Web interface (Nuxt.js)

• vipr-api - REST API backend (FastAPI) with async processing (Celery)

• vipr-core - Extensible plugin framework (Python CLI)

Component Repositories

• vipr-core - Core framework repository

• vipr-api - API service repository

• vipr-frontend - Frontend repository

• vipr-reflectometry-plugin - Reflectometry plugin

License

The VIPR Framework is licensed under the GNU Lesser General Public License v3.0 (LGPL-3.0).

For details, see the LICENSE.txt file in each repository (for example vipr-framework/LICENSE.txt).