retrieval / README.md
kunle-ogunleye's picture
Upload 5 files
62987dd verified
|
Raw
History Blame Contribute Delete
2.44 kB
---
license: mit
tags:
- pytorch
- efficientformer
- retrieval
---
# Efficientformer for Retrieval
## Overview
Working implementation of **Efficientformer** for **Retrieval** using a **huge** configuration. The repository focuses on transparent code and repeatable smoke tests; benchmark claims are deliberately omitted.
## Repository status
- The Python file contains the model and runnable example or training entry point.
- `config.json` records the generated architecture settings.
- `training_args.json` records the default experiment recipe.
- `model.safetensors` is a valid initialization checkpoint for smoke tests; it is **not** presented as a trained benchmark checkpoint.
- No benchmark score is claimed in this repository.
## Architecture
| Item | Value |
|---|---|
| Architecture | Efficientformer |
| Scale | huge |
| Attention | standard |
| Fusion | tensor fusion |
| Activation | mish |
| Normalization | groupnorm |
## Default experiment recipe
The included configuration uses **lamb** with a **step** schedule. These are starting values in the script, not evidence of a completed run. For a meaningful evaluation, train all baselines with the same data exposure, tuning budget, and random seeds.
## Quick check
```bash
python pipeline.py --help
```
Inspect the script's `__main__` block for its generated smoke-test example. Because this is a custom implementation, generic automatic loading APIs require an explicit adapter before use.
## Evaluation guidance
A useful first evaluation would use **Flickr30k**, report the task metric across at least three seeds, and include a matched-capacity baseline. Keep training logs and environment versions with any published result.
## Limitations
The initialization checkpoint has not been trained or audited for robustness, fairness, or domain transfer. The implementation should be treated as an experimental starting point. Results from a future trained checkpoint must be documented separately from the defaults shipped here.
## Files
- `pipeline.py` β€” primary artifact
- `README.md` β€” this documentation
- `config.json` β€” architecture configuration
- `training_args.json` β€” default experiment settings
- `model.safetensors` β€” initialization checkpoint
## License
Released under **mit**. Review the source-data terms separately when this repository is used with external datasets.