Skip to content

Commit

Permalink
added more sections
Browse files Browse the repository at this point in the history
  • Loading branch information
elliesch authored Mar 8, 2024
1 parent 4e2d833 commit 355b60b
Showing 1 changed file with 41 additions and 3 deletions.
44 changes: 41 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,44 @@
# Flip-n-Slide
## A Concise Tiling Strategy for Preserving Spatial Context in Earth Observation Imagery

Flip-n-Slide is a concise tiling strategy for large scientific images that preserves spatial context in preprocessing for use with GPU-enabled deep learning algorithms. Flip-n-Slide allows objects-of-interest to be represented at multiple tile positions and orientations, improving the detection of underrepresented classes (<5% of overall data) in cases of class imbalance from preprocessing alone. This approach can also be implemented alongside optimizations and architectures for cases of extreme class imbalance (<1% of overall data) to allow for further improved accuracy and prediction.
Flip-n-Slide is a concise tiling and augmentation strategy to prepare large scientific images for use with GPU-enabled algorithms. `flipnslide` is a Python package that outputs PyTorch ready preprocessed datasets from a single large image.

## Here will go instructions for use when ready.
## Documentation

The documentation for `flipnside` is under construction, and will be hosted on [Read the Docs]().

## Installation and Dependencies

For now, `flipnside` can be implemented locally by cloning this repository.

```bash
git clone https://github.com/elliesch/flipnslide.git
```
Check back next week for instructions on installing this from PyPI and Conda Forge.

## Attribution

If you make use of this code, please cite the ICLR paper:

@inproceedings{DBLP:conf/iclr/HuangLCQFTL23,
author = {Ellianna Abrahams and
Tasha Snow and
Matthew R. Siegfried and
Fernando Pérez},
title = {A Concise Tiling Strategy for Preserving Spatial Context in Earth Observation Imagery},
booktitle = {The Twelfth International Conference on Learning Representations,
{ICLR} 2024, Vienna, Austria, May 7-11, 2024},
publisher = {OpenReview.net},
year = {2024},
url = {upcoming},
}

## License

Copyright 2024 Ellianna Abrahams, Tasha Snow, Matthew R. Siegfried, Fernando Pérez, and contributors.

``flipnslide`` is free software made available under the MIT License. For details see
the [LICENSE](https://github.com/elliesch/flipnslide/blob/main/LICENSE) file.

## Contributors

See the upcoming AUTHORS file for a complete list of contributors to the project.

0 comments on commit 355b60b

Please sign in to comment.