# VIPR Framework Documentation

Welcome to the VIPR Framework documentation.

```{toctree}
:maxdepth: 2
:caption: Getting Started

docs/TLDR VIPR Introduction <docs/TLDR VIPR Introduction.pdf>
VIPR_CLI
VIPR_web_app
docs/web-app/inference-flow
```

```{toctree}
:maxdepth: 2
:caption: Setup & Configuration

docs/setup/authentication
docs/installation/cli
docs/installation/docker
```

```{toctree}
:maxdepth: 2
:caption: CLI Usage

docs/cli/commands
```

```{toctree}
:maxdepth: 2
:caption: Plugins

docs/plugins/README
docs/plugins/built-in/api/README
docs/plugins/built-in/api/usage
docs/plugins/built-in/api/visualization
docs/plugins/built-in/discovery
docs/plugins/built-in/huggingface
docs/plugins/built-in/inference
docs/plugins/built-in/normalizers
docs/plugins/built-in/performance
docs/plugins/filters
docs/plugins/external/reflectometry/index
docs/plugins/external/gid/index
```

```{toctree}
:maxdepth: 2
:caption: Extensions

docs/extensions/strict_registration
docs/extensions/dynamic_hooks_filters
```

## 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](https://codebase.helmholtz.cloud/vipr/vipr-core) - Core framework repository
- [vipr-api](https://codebase.helmholtz.cloud/vipr/vipr-api) - API service repository
- [vipr-frontend](https://codebase.helmholtz.cloud/vipr/vipr-frontend) - Frontend repository
- [vipr-reflectometry-plugin](https://codebase.helmholtz.cloud/vipr/vipr-reflectorch-plugin) - Reflectometry plugin