Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
VIPR Framework Documentation
Logo

Getting Started

  • Web App Inference Flow

Setup & Configuration

  • Authentication
  • VIPR Framework - CLI Installation
  • Docker Deployment

CLI Usage

  • VIPR Framework - CLI Reference

Plugins

  • VIPR Plugins
  • API Plugin Documentation
  • API Plugin - Usage Guide
  • Matplotlib Visualization Configuration
  • HTTP API Routes
  • Discovery Plugin Documentation
  • HuggingFace Plugin
  • Inference Plugin Documentation
  • Normalizers Plugin Documentation
  • Performance Monitoring Plugin
  • Filter Documentation
  • Reflectometry Plugin Documentation
    • Handler Implementation Patterns
    • Filters & Hooks Integration
    • Configuration Examples
  • GID Plugin Documentation
    • Configuration
    • Visualization

Extensions

  • Strict Hook/Filter Registration Extension
  • Dynamic Hooks and Filters Extension

API Reference

  • vipr
    • vipr package
      • vipr.controllers package
      • vipr.core package
      • vipr.ext package
        • vipr.ext.dynamic_hooks_filters package
      • vipr.handlers package
      • vipr.interfaces package
      • vipr.losses package
      • vipr.optimizers package
      • vipr.plugins package
        • vipr.plugins.api package
          • vipr.plugins.api.exporters package
          • vipr.plugins.api.fastapi package
            • vipr.plugins.api.fastapi.router_generator package
          • vipr.plugins.api.plot_scripts package
        • vipr.plugins.celery package
        • vipr.plugins.discovery package
        • vipr.plugins.huggingface package
        • vipr.plugins.inference package
          • vipr.plugins.inference.steps package
        • vipr.plugins.normalizers package
          • vipr.plugins.normalizers.interfaces package
        • vipr.plugins.performance package
  • vipr_api
    • vipr_api package
      • vipr_api.celery package
        • vipr_api.celery.src package
          • vipr_api.celery.src.tasks package
          • vipr_api.celery.src.utils package
      • vipr_api.streaming package
      • vipr_api.web package
        • vipr_api.web.models package
        • vipr_api.web.routers package
          • vipr_api.web.routers.inference package
          • vipr_api.web.routers.panpe package
          • vipr_api.web.routers.plugins package
          • vipr_api.web.routers.reflectorch package
  • vipr_reflectometry
    • vipr_reflectometry package
      • vipr_reflectometry.flow_models package
        • vipr_reflectometry.flow_models.load_model package
          • vipr_reflectometry.flow_models.load_model.models package
            • vipr_reflectometry.flow_models.load_model.models.networks package
        • vipr_reflectometry.flow_models.plot_scripts package
        • vipr_reflectometry.flow_models.postprocess package
          • vipr_reflectometry.flow_models.postprocess.cluster package
            • vipr_reflectometry.flow_models.postprocess.cluster.clustering package
              • vipr_reflectometry.flow_models.postprocess.cluster.clustering.visualization package
            • vipr_reflectometry.flow_models.postprocess.cluster.model_selection package
        • vipr_reflectometry.flow_models.predict package
        • vipr_reflectometry.flow_models.preprocess package
      • vipr_reflectometry.panpe package
        • vipr_reflectometry.panpe.load_model package
        • vipr_reflectometry.panpe.plot_scripts package
        • vipr_reflectometry.panpe.postprocess package
          • vipr_reflectometry.panpe.postprocess.data_collectors package
        • vipr_reflectometry.panpe.predict package
      • vipr_reflectometry.reflectorch package
        • vipr_reflectometry.reflectorch.examples package
        • vipr_reflectometry.reflectorch.load_model package
        • vipr_reflectometry.reflectorch.plot_scripts package
        • vipr_reflectometry.reflectorch.postprocess package
          • vipr_reflectometry.reflectorch.postprocess.data_collectors package
        • vipr_reflectometry.reflectorch.predict package
        • vipr_reflectometry.reflectorch.preprocess package
      • vipr_reflectometry.shared package
        • vipr_reflectometry.shared.controllers package
        • vipr_reflectometry.shared.load_data package
Back to top
View this page

vipr_apiΒΆ

  • vipr_api package
    • Subpackages
      • vipr_api.celery package
        • Subpackages
        • Submodules
        • vipr_api.celery.celery_app module
        • vipr_api.celery.daemon_task module
        • Module contents
      • vipr_api.streaming package
        • Submodules
        • vipr_api.streaming.rabbitmq_consumer module
        • Module contents
      • vipr_api.web package
        • Subpackages
        • Module contents
    • Submodules
    • vipr_api.config_utils module
      • get_config_path()
    • Module contents
Next
vipr_api package
Previous
vipr.plugins.performance package
Copyright © 2025, VIPR Consortium
Made with Sphinx and @pradyunsg's Furo