Add INT8 quantized models for mobile deployment
Browse filesMAJOR ADDITION: Mobile-optimized quantized models
- INT8 quantized encoder: 430MB → 108MB (75% reduction)
- INT8 quantized decoder: 647MB → 164MB (75% reduction)
- Total compression: 1.1GB → 272MB (4x smaller)
Model variants now available:
- FP32 Quality models: Maximum accuracy for server/desktop (1.1GB)
- INT8 Mobile models: Optimized for iOS apps and mobile deployment (272MB)
Features:
- iOS 15+ compatible quantization
- Preserved 512-token sequence length
- Minimal quality loss from quantization
- Production-ready for mobile applications
Documentation updated with:
- Model selection guidance
- Usage examples for both variants
- Performance comparison table
- Mobile deployment recommendations
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
- .DS_Store +0 -0
- README.md +48 -8
- config.json +28 -7
- flan_t5_base_decoder_int8.mlpackage/Data/com.apple.CoreML/model.mlmodel +3 -0
- flan_t5_base_decoder_int8.mlpackage/Data/com.apple.CoreML/weights/weight.bin +3 -0
- flan_t5_base_decoder_int8.mlpackage/Manifest.json +3 -0
- flan_t5_base_encoder_int8.mlpackage/Data/com.apple.CoreML/model.mlmodel +3 -0
- flan_t5_base_encoder_int8.mlpackage/Data/com.apple.CoreML/weights/weight.bin +3 -0
- flan_t5_base_encoder_int8.mlpackage/Manifest.json +3 -0
|
Binary files a/.DS_Store and b/.DS_Store differ
|
|
|
|
@@ -11,9 +11,8 @@ This repository contains **high-quality** CoreML versions of Google's FLAN-T5 Ba
|
|
| 11 |
- **Base Model**: [google/flan-t5-base](https://huggingface.co/google/flan-t5-base)
|
| 12 |
- **Architecture**: T5 (Text-to-Text Transfer Transformer)
|
| 13 |
- **Model Size**:
|
| 14 |
-
-
|
| 15 |
-
-
|
| 16 |
-
- Total: ~1.1GB
|
| 17 |
- **Framework**: CoreML (.mlpackage format)
|
| 18 |
- **Precision**: FP32 for maximum quality preservation
|
| 19 |
- **Deployment Target**: iOS 15+ / macOS 12+
|
|
@@ -22,8 +21,14 @@ This repository contains **high-quality** CoreML versions of Google's FLAN-T5 Ba
|
|
| 22 |
## Files
|
| 23 |
|
| 24 |
### Model Files
|
| 25 |
-
|
| 26 |
-
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 27 |
|
| 28 |
### Tokenizer Files
|
| 29 |
- `tokenizer.json` - Fast tokenizer configuration
|
|
@@ -55,6 +60,21 @@ FLAN-T5 is an encoder-decoder transformer model that has been converted into two
|
|
| 55 |
- **✅ Preserved Precision**: FP32 precision maintains model accuracy
|
| 56 |
- **✅ Original Architecture**: 512-token sequences preserve full model capabilities
|
| 57 |
- **✅ Production Ready**: Suitable for real-world applications
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 58 |
|
| 59 |
## Usage
|
| 60 |
|
|
@@ -64,9 +84,14 @@ FLAN-T5 is an encoder-decoder transformer model that has been converted into two
|
|
| 64 |
# Download complete repository
|
| 65 |
huggingface-cli download mazhewitt/flan-t5-base-coreml --local-dir ./models
|
| 66 |
|
| 67 |
-
# Download specific models
|
|
|
|
| 68 |
huggingface-cli download mazhewitt/flan-t5-base-coreml flan_t5_base_encoder_quality.mlpackage --local-dir ./models
|
| 69 |
huggingface-cli download mazhewitt/flan-t5-base-coreml flan_t5_base_decoder_quality.mlpackage --local-dir ./models
|
|
|
|
|
|
|
|
|
|
|
|
|
| 70 |
```
|
| 71 |
|
| 72 |
### Python Usage with Working Text Generation
|
|
@@ -77,8 +102,14 @@ import numpy as np
|
|
| 77 |
from transformers import T5Tokenizer
|
| 78 |
|
| 79 |
# Load models and tokenizer
|
|
|
|
| 80 |
encoder = ct.models.MLModel("flan_t5_base_encoder_quality.mlpackage")
|
| 81 |
decoder = ct.models.MLModel("flan_t5_base_decoder_quality.mlpackage")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 82 |
tokenizer = T5Tokenizer.from_pretrained("./")
|
| 83 |
|
| 84 |
# Example: Translation with high-quality generation
|
|
@@ -136,11 +167,18 @@ print(f"Translation: {result}")
|
|
| 136 |
import CoreML
|
| 137 |
|
| 138 |
// Load models
|
|
|
|
| 139 |
guard let encoderURL = Bundle.main.url(forResource: "flan_t5_base_encoder_quality", withExtension: "mlpackage"),
|
| 140 |
let decoderURL = Bundle.main.url(forResource: "flan_t5_base_decoder_quality", withExtension: "mlpackage") else {
|
| 141 |
fatalError("Models not found")
|
| 142 |
}
|
| 143 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 144 |
let encoderModel = try MLModel(contentsOf: encoderURL)
|
| 145 |
let decoderModel = try MLModel(contentsOf: decoderURL)
|
| 146 |
|
|
@@ -159,8 +197,10 @@ FLAN-T5 has been instruction-tuned and can perform various text-to-text tasks:
|
|
| 159 |
|
| 160 |
## Performance Considerations
|
| 161 |
|
| 162 |
-
- **Memory**:
|
| 163 |
-
- **
|
|
|
|
|
|
|
| 164 |
- **Sequence Length**: Maximum 512 tokens (full original capacity)
|
| 165 |
- **Device Compatibility**: Apple Neural Engine, GPU, or CPU depending on availability
|
| 166 |
- **Generation Speed**: Optimized for real-time text generation on mobile devices
|
|
|
|
| 11 |
- **Base Model**: [google/flan-t5-base](https://huggingface.co/google/flan-t5-base)
|
| 12 |
- **Architecture**: T5 (Text-to-Text Transfer Transformer)
|
| 13 |
- **Model Size**:
|
| 14 |
+
- **FP32 (Quality)**: Encoder 430MB, Decoder 647MB = 1.1GB total
|
| 15 |
+
- **INT8 (Mobile)**: Encoder 108MB, Decoder 164MB = 272MB total (4x smaller)
|
|
|
|
| 16 |
- **Framework**: CoreML (.mlpackage format)
|
| 17 |
- **Precision**: FP32 for maximum quality preservation
|
| 18 |
- **Deployment Target**: iOS 15+ / macOS 12+
|
|
|
|
| 21 |
## Files
|
| 22 |
|
| 23 |
### Model Files
|
| 24 |
+
|
| 25 |
+
**High-Quality Models (FP32)**
|
| 26 |
+
- `flan_t5_base_encoder_quality.mlpackage` - T5 Encoder component (512 tokens, FP32, 430MB)
|
| 27 |
+
- `flan_t5_base_decoder_quality.mlpackage` - T5 Decoder component (512 tokens, FP32, 647MB)
|
| 28 |
+
|
| 29 |
+
**Quantized Models (INT8) - Recommended for Mobile**
|
| 30 |
+
- `flan_t5_base_encoder_int8.mlpackage` - T5 Encoder component (512 tokens, INT8, 108MB)
|
| 31 |
+
- `flan_t5_base_decoder_int8.mlpackage` - T5 Decoder component (512 tokens, INT8, 164MB)
|
| 32 |
|
| 33 |
### Tokenizer Files
|
| 34 |
- `tokenizer.json` - Fast tokenizer configuration
|
|
|
|
| 60 |
- **✅ Preserved Precision**: FP32 precision maintains model accuracy
|
| 61 |
- **✅ Original Architecture**: 512-token sequences preserve full model capabilities
|
| 62 |
- **✅ Production Ready**: Suitable for real-world applications
|
| 63 |
+
- **✅ Mobile Optimized**: INT8 quantized versions for deployment on iOS devices
|
| 64 |
+
|
| 65 |
+
## 🔄 Model Variants
|
| 66 |
+
|
| 67 |
+
**Choose the right model for your use case:**
|
| 68 |
+
|
| 69 |
+
| Model Type | Size | Use Case | Quality | Memory |
|
| 70 |
+
|------------|------|----------|---------|---------|
|
| 71 |
+
| **FP32 Quality** | 1.1GB | Server/Desktop apps, Research | Highest | High |
|
| 72 |
+
| **INT8 Mobile** | 272MB | iOS/Mobile apps, Production | Very Good | Low |
|
| 73 |
+
|
| 74 |
+
**Recommendations:**
|
| 75 |
+
- **iOS/Mobile Apps**: Use INT8 models for better performance and lower memory usage
|
| 76 |
+
- **Server/Desktop**: Use FP32 models for maximum quality
|
| 77 |
+
- **Development/Testing**: Start with INT8, upgrade to FP32 if needed
|
| 78 |
|
| 79 |
## Usage
|
| 80 |
|
|
|
|
| 84 |
# Download complete repository
|
| 85 |
huggingface-cli download mazhewitt/flan-t5-base-coreml --local-dir ./models
|
| 86 |
|
| 87 |
+
# Download specific models (choose quality vs mobile-optimized)
|
| 88 |
+
# High-quality FP32 models
|
| 89 |
huggingface-cli download mazhewitt/flan-t5-base-coreml flan_t5_base_encoder_quality.mlpackage --local-dir ./models
|
| 90 |
huggingface-cli download mazhewitt/flan-t5-base-coreml flan_t5_base_decoder_quality.mlpackage --local-dir ./models
|
| 91 |
+
|
| 92 |
+
# Mobile-optimized INT8 models (recommended for iOS/mobile apps)
|
| 93 |
+
huggingface-cli download mazhewitt/flan-t5-base-coreml flan_t5_base_encoder_int8.mlpackage --local-dir ./models
|
| 94 |
+
huggingface-cli download mazhewitt/flan-t5-base-coreml flan_t5_base_decoder_int8.mlpackage --local-dir ./models
|
| 95 |
```
|
| 96 |
|
| 97 |
### Python Usage with Working Text Generation
|
|
|
|
| 102 |
from transformers import T5Tokenizer
|
| 103 |
|
| 104 |
# Load models and tokenizer
|
| 105 |
+
# Option 1: High-quality FP32 models (1.1GB)
|
| 106 |
encoder = ct.models.MLModel("flan_t5_base_encoder_quality.mlpackage")
|
| 107 |
decoder = ct.models.MLModel("flan_t5_base_decoder_quality.mlpackage")
|
| 108 |
+
|
| 109 |
+
# Option 2: Mobile-optimized INT8 models (272MB) - Recommended for iOS apps
|
| 110 |
+
# encoder = ct.models.MLModel("flan_t5_base_encoder_int8.mlpackage")
|
| 111 |
+
# decoder = ct.models.MLModel("flan_t5_base_decoder_int8.mlpackage")
|
| 112 |
+
|
| 113 |
tokenizer = T5Tokenizer.from_pretrained("./")
|
| 114 |
|
| 115 |
# Example: Translation with high-quality generation
|
|
|
|
| 167 |
import CoreML
|
| 168 |
|
| 169 |
// Load models
|
| 170 |
+
// Option 1: High-quality FP32 models
|
| 171 |
guard let encoderURL = Bundle.main.url(forResource: "flan_t5_base_encoder_quality", withExtension: "mlpackage"),
|
| 172 |
let decoderURL = Bundle.main.url(forResource: "flan_t5_base_decoder_quality", withExtension: "mlpackage") else {
|
| 173 |
fatalError("Models not found")
|
| 174 |
}
|
| 175 |
|
| 176 |
+
// Option 2: Mobile-optimized INT8 models (recommended for iOS apps)
|
| 177 |
+
// guard let encoderURL = Bundle.main.url(forResource: "flan_t5_base_encoder_int8", withExtension: "mlpackage"),
|
| 178 |
+
// let decoderURL = Bundle.main.url(forResource: "flan_t5_base_decoder_int8", withExtension: "mlpackage") else {
|
| 179 |
+
fatalError("Models not found")
|
| 180 |
+
}
|
| 181 |
+
|
| 182 |
let encoderModel = try MLModel(contentsOf: encoderURL)
|
| 183 |
let decoderModel = try MLModel(contentsOf: decoderURL)
|
| 184 |
|
|
|
|
| 197 |
|
| 198 |
## Performance Considerations
|
| 199 |
|
| 200 |
+
- **Memory**:
|
| 201 |
+
- **FP32 Models**: ~1.1GB total (maximum quality)
|
| 202 |
+
- **INT8 Models**: ~272MB total (4x smaller, mobile-optimized)
|
| 203 |
+
- **Precision**: FP32 for quality, INT8 for mobile deployment
|
| 204 |
- **Sequence Length**: Maximum 512 tokens (full original capacity)
|
| 205 |
- **Device Compatibility**: Apple Neural Engine, GPU, or CPU depending on availability
|
| 206 |
- **Generation Speed**: Optimized for real-time text generation on mobile devices
|
|
@@ -38,8 +38,18 @@
|
|
| 38 |
}
|
| 39 |
},
|
| 40 |
"model_files": {
|
| 41 |
-
"
|
| 42 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 43 |
},
|
| 44 |
"tokenizer_files": {
|
| 45 |
"tokenizer": "tokenizer.json",
|
|
@@ -53,19 +63,30 @@
|
|
| 53 |
"multiple_tasks": true,
|
| 54 |
"full_sequence_length": true,
|
| 55 |
"quality_preservation": true,
|
| 56 |
-
"production_ready": true
|
|
|
|
|
|
|
| 57 |
},
|
| 58 |
"performance": {
|
| 59 |
-
"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 60 |
"max_sequence_length": 512,
|
| 61 |
-
"precision": "FP32",
|
| 62 |
"device_compatibility": ["Apple Neural Engine", "GPU", "CPU"]
|
| 63 |
},
|
| 64 |
"usage_notes": {
|
|
|
|
| 65 |
"sequence_length": "Both encoder and decoder use 512 tokens maximum (full original capacity)",
|
| 66 |
"decoder_start": "Always start decoder with tokenizer.pad_token_id",
|
| 67 |
"generation": "Use greedy decoding for best results",
|
| 68 |
-
"
|
| 69 |
-
"quality": "FP32 precision ensures maximum quality preservation"
|
| 70 |
}
|
| 71 |
}
|
|
|
|
| 38 |
}
|
| 39 |
},
|
| 40 |
"model_files": {
|
| 41 |
+
"fp32_quality": {
|
| 42 |
+
"encoder": "flan_t5_base_encoder_quality.mlpackage",
|
| 43 |
+
"decoder": "flan_t5_base_decoder_quality.mlpackage",
|
| 44 |
+
"total_size_mb": 1100,
|
| 45 |
+
"description": "High-quality FP32 models for maximum accuracy"
|
| 46 |
+
},
|
| 47 |
+
"int8_mobile": {
|
| 48 |
+
"encoder": "flan_t5_base_encoder_int8.mlpackage",
|
| 49 |
+
"decoder": "flan_t5_base_decoder_int8.mlpackage",
|
| 50 |
+
"total_size_mb": 272,
|
| 51 |
+
"description": "Mobile-optimized INT8 models (4x compression)"
|
| 52 |
+
}
|
| 53 |
},
|
| 54 |
"tokenizer_files": {
|
| 55 |
"tokenizer": "tokenizer.json",
|
|
|
|
| 63 |
"multiple_tasks": true,
|
| 64 |
"full_sequence_length": true,
|
| 65 |
"quality_preservation": true,
|
| 66 |
+
"production_ready": true,
|
| 67 |
+
"mobile_optimized": true,
|
| 68 |
+
"quantized_variants": true
|
| 69 |
},
|
| 70 |
"performance": {
|
| 71 |
+
"fp32_models": {
|
| 72 |
+
"total_memory_mb": 1100,
|
| 73 |
+
"precision": "FP32",
|
| 74 |
+
"use_case": "Maximum quality, server/desktop apps"
|
| 75 |
+
},
|
| 76 |
+
"int8_models": {
|
| 77 |
+
"total_memory_mb": 272,
|
| 78 |
+
"precision": "INT8",
|
| 79 |
+
"compression_ratio": "4x",
|
| 80 |
+
"use_case": "Mobile apps, production deployment"
|
| 81 |
+
},
|
| 82 |
"max_sequence_length": 512,
|
|
|
|
| 83 |
"device_compatibility": ["Apple Neural Engine", "GPU", "CPU"]
|
| 84 |
},
|
| 85 |
"usage_notes": {
|
| 86 |
+
"model_selection": "Use INT8 for mobile apps, FP32 for maximum quality",
|
| 87 |
"sequence_length": "Both encoder and decoder use 512 tokens maximum (full original capacity)",
|
| 88 |
"decoder_start": "Always start decoder with tokenizer.pad_token_id",
|
| 89 |
"generation": "Use greedy decoding for best results",
|
| 90 |
+
"quantization": "INT8 models provide 4x compression with minimal quality loss"
|
|
|
|
| 91 |
}
|
| 92 |
}
|
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:4e83a3c316e30dca89a809fae6a956bd8fda590561025131a013498e3e6f1bb8
|
| 3 |
+
size 1013348
|
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:0db52d7d5f7c79fb12334b657bec3d5ef5b48a5253c837d33161c4b7128f8381
|
| 3 |
+
size 171291008
|
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:bfa4b37862ae4fa714a152f174cd6813649f3a700939c09c944456cbf671e39c
|
| 3 |
+
size 617
|
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:8f71f2f96f5542cd2b4a1b0c38de9f9badcd050ead784a22cd7c4bbd95a76335
|
| 3 |
+
size 145776
|
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:67b779d52a04dabfd9445f248994c7648b3593a83be62ef1bea63196d00db18a
|
| 3 |
+
size 113400064
|
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:dc0b57ca4c68fafd92dfd2a9914507df18dad765ff9492aa3cf0d0d071988afc
|
| 3 |
+
size 617
|