Metadata-Version: 2.1
Name: rshf
Version: 0.1.2
Summary: RS pretrained models in huggingface style
Home-page: https://github.com/mvrl/rshf
Author: Srikumar Sastry
Author-email: s.sastry@wustl.edu
Keywords: Remote Sensing,Huggingface
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: torch>=2.3.0
Requires-Dist: timm>=1.0.3
Requires-Dist: numpy<=2.0
Requires-Dist: huggingface_hub>=0.23.1
Requires-Dist: einops>=0.8.0
Requires-Dist: transformers>=4.41.1
Requires-Dist: open_clip_torch>=2.24.0
Requires-Dist: torchaudio

# rshf
### Remote sensing pretrained models easy loading using huggingface -- PyTorch (for fast benchmarking)

### Installation:
```bash
pip install rshf
```

### Example:
```python
from rshf.satmae import SatMAE
model = SatMAE.from_pretrained("MVRL/satmae-vitlarge-fmow-pretrain-800")
input = model.transform(torch.randint(0, 256, (224, 224, 3)).float().numpy(), 224).unsqueeze(0)
print(model.forward_encoder(input, mask_ratio=0.0)[0].shape)
```

### TODO:
- [ ] Add transforms for each model
- [ ] Add Documentation (https://rshf-docs.readthedocs.io/en/latest/)
- [x] Add initial set of models

### Citations

|Model Type|Venue|Citation|
|----------|-----|--------|
|BioCLIP|CVPR'24|[link](./rshf/bioclip/README.md)
|CLIP|ICML'21|[link](./rshf/clip/README.md)
|CROMA|NeurIPS'23|[link](./rshf/croma/README.md)
|GeoCLAP|BMVC'23|[link](./rshf/geoclap/README.md)
|GeoCLIP|NeurIPS'23|[link](./rshf/geoclip/README.md)
|Presto||[link](./rshf/presto/README.md)
|Prithvi||[link](./rshf/prithvi/README.md)
|RemoteCLIP|TGRS'23|[link](./rshf/remoteclip/README.md)
|RVSA|TGRS'22|[link](./rshf/rvsa/README.md)
|Sat2Cap|EarthVision'24|[link](./rshf/sat2cap/README.md)
|SatClip||[link](./rshf/satclip/README.md)
|SatMAE|NeurIPS'22|[link](./rshf/satmae/README.md)
|SatMAE++|CVPR'24|[link](./rshf/satmaepp/README.md)
|ScaleMAE|ICCV'23|[link](./rshf/scalemae/README.md)
|SINR|ICML'23|[link](./rshf/sinr/README.md)
|StreetCLIP||[link](./rshf/streetclip/README.md)
|TaxaBind|WACV'25|[link](./rshf/taxabind/README.md)
### List of models available here: [Link](https://huggingface.co/collections/MVRL/remote-sensing-foundation-models-664e8fcd67d8ca8c03f42d00)
