Update README.md
Browse files
README.md
CHANGED
|
@@ -7,10 +7,13 @@ It combines global attention-based reasoning with patch-level self-consistency a
|
|
| 7 |
|
| 8 |
The model is designed to indicate **where anomalies occur** and **how strongly they deviate from expected visual consistency**, supporting explainable image analysis and integrity assessment.
|
| 9 |
|
|
|
|
| 10 |
---
|
| 11 |
|
| 12 |
## Architecture Overview
|
| 13 |
|
|
|
|
|
|
|
| 14 |
VAAS consists of two complementary components:
|
| 15 |
|
| 16 |
- **Global Attention Module (Fx)**
|
|
@@ -44,24 +47,40 @@ This release corresponds to:
|
|
| 44 |
Future releases will scale training data size, include cross-dataset evaluation, and explore model compression.
|
| 45 |
|
| 46 |
---
|
| 47 |
-
|
| 48 |
## Intended Use
|
| 49 |
|
| 50 |
This model can be used for:
|
| 51 |
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
|
| 58 |
-
It supports
|
|
|
|
| 59 |
|
| 60 |
---
|
| 61 |
|
| 62 |
-
##
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 63 |
|
| 64 |
-
|
|
|
|
|
|
|
| 65 |
|
| 66 |
```python
|
| 67 |
from vaas.inference.pipeline import VAASPipeline
|
|
@@ -93,33 +112,45 @@ anomaly_map = result["anomaly_map"]
|
|
| 93 |
|
| 94 |
---
|
| 95 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 96 |
## Training Data
|
| 97 |
|
| 98 |
-
The model was trained on a reproducible 10% subset of DF2023.
|
| 99 |
-
The exact filenames used for training are released to support
|
| 100 |
|
| 101 |
---
|
| 102 |
|
| 103 |
## Limitations
|
| 104 |
|
| 105 |
-
|
| 106 |
-
|
| 107 |
-
|
| 108 |
|
| 109 |
-
Users are encouraged to fine-tune or retrain for domain-specific applications.
|
| 110 |
|
| 111 |
---
|
| 112 |
|
| 113 |
## Ethical Considerations
|
| 114 |
|
| 115 |
VAAS is intended for research and inspection purposes.
|
| 116 |
-
It should not be used as a standalone decision-making system in high-stakes
|
| 117 |
|
| 118 |
---
|
| 119 |
|
| 120 |
## Citation
|
| 121 |
|
| 122 |
-
|
| 123 |
|
| 124 |
```
|
| 125 |
Bamigbade, O., Scanlon, M., Sheppard, J.
|
|
@@ -137,5 +168,5 @@ MIT License
|
|
| 137 |
|
| 138 |
## Maintainers
|
| 139 |
|
| 140 |
-
OBA-Research
|
| 141 |
-
https://huggingface.co/OBA-Research
|
|
|
|
| 7 |
|
| 8 |
The model is designed to indicate **where anomalies occur** and **how strongly they deviate from expected visual consistency**, supporting explainable image analysis and integrity assessment.
|
| 9 |
|
| 10 |
+
Paper link: *to be added upon publication*
|
| 11 |
---
|
| 12 |
|
| 13 |
## Architecture Overview
|
| 14 |
|
| 15 |
+

|
| 16 |
+
|
| 17 |
VAAS consists of two complementary components:
|
| 18 |
|
| 19 |
- **Global Attention Module (Fx)**
|
|
|
|
| 47 |
Future releases will scale training data size, include cross-dataset evaluation, and explore model compression.
|
| 48 |
|
| 49 |
---
|
|
|
|
| 50 |
## Intended Use
|
| 51 |
|
| 52 |
This model can be used for:
|
| 53 |
|
| 54 |
+
* Image anomaly detection
|
| 55 |
+
* Visual integrity assessment
|
| 56 |
+
* Explainable inspection of irregular regions
|
| 57 |
+
* Research on attention-based anomaly scoring
|
| 58 |
+
* Prototyping anomaly-aware vision systems
|
| 59 |
|
| 60 |
+
It supports **CPU-only inference** and **GPU-accelerated inference**.
|
| 61 |
+
GPU usage is recommended for faster processing but is not required.
|
| 62 |
|
| 63 |
---
|
| 64 |
|
| 65 |
+
## Installation
|
| 66 |
+
|
| 67 |
+
VAAS is distributed as a lightweight inference library.
|
| 68 |
+
Users must install **PyTorch** separately to match their system (CPU or GPU).
|
| 69 |
+
|
| 70 |
+
### 1. Install PyTorch
|
| 71 |
+
|
| 72 |
+
Follow the official PyTorch installation guide for your platform:
|
| 73 |
+
[https://pytorch.org/get-started/locally/](https://pytorch.org/get-started/locally/)
|
| 74 |
+
|
| 75 |
+
### 2. Install VAAS
|
| 76 |
+
|
| 77 |
+
```bash
|
| 78 |
+
pip install vaas
|
| 79 |
+
```
|
| 80 |
|
| 81 |
+
---
|
| 82 |
+
|
| 83 |
+
## Usage
|
| 84 |
|
| 85 |
```python
|
| 86 |
from vaas.inference.pipeline import VAASPipeline
|
|
|
|
| 112 |
|
| 113 |
---
|
| 114 |
|
| 115 |
+
## Model Files
|
| 116 |
+
|
| 117 |
+
This repository contains:
|
| 118 |
+
|
| 119 |
+
* `px_model.pth` – Patch-level SegFormer model weights
|
| 120 |
+
* `ref_stats.pth` – Reference statistics for anomaly normalization
|
| 121 |
+
* `config.json` – Model configuration metadata
|
| 122 |
+
|
| 123 |
+
The Vision Transformer backbone is loaded programmatically during inference.
|
| 124 |
+
|
| 125 |
+
---
|
| 126 |
+
|
| 127 |
## Training Data
|
| 128 |
|
| 129 |
+
The model was trained on a reproducible 10% subset of the DF2023 dataset.
|
| 130 |
+
The exact filenames used for training are released to support experimental reproducibility.
|
| 131 |
|
| 132 |
---
|
| 133 |
|
| 134 |
## Limitations
|
| 135 |
|
| 136 |
+
* Trained on a subset of a single dataset
|
| 137 |
+
* Does not classify anomaly types
|
| 138 |
+
* Performance may degrade on out-of-distribution imagery
|
| 139 |
|
| 140 |
+
Users are encouraged to fine-tune or retrain the model for domain-specific applications.
|
| 141 |
|
| 142 |
---
|
| 143 |
|
| 144 |
## Ethical Considerations
|
| 145 |
|
| 146 |
VAAS is intended for research and inspection purposes.
|
| 147 |
+
It should not be used as a standalone decision-making system in high-stakes or sensitive applications without human oversight.
|
| 148 |
|
| 149 |
---
|
| 150 |
|
| 151 |
## Citation
|
| 152 |
|
| 153 |
+
Please cite the following work (citation will be updated upon publication):
|
| 154 |
|
| 155 |
```
|
| 156 |
Bamigbade, O., Scanlon, M., Sheppard, J.
|
|
|
|
| 168 |
|
| 169 |
## Maintainers
|
| 170 |
|
| 171 |
+
**OBA-Research**
|
| 172 |
+
[https://huggingface.co/OBA-Research](https://huggingface.co/OBA-Research)
|