Skip to content

Add docs to readme #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rustamdantia merged 2 commits into from
Mar 18, 2025
Merged

Add docs to readme #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
132ab2b
Update version in docs/source/conf.py
rustamdantia Mar 17, 2025
34f25d8
Update README with links to log post and docs.
rustamdantia Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,18 @@

# GeoGrapher

*GeoGrapher* is a Python library for building remote sensing
computer vision datasets starting from vector features
(e.g. locations or georeferenced bounding boxes or segmentation maks).
It connects the features and images by a bipartite graph that keeps
track of the containment and intersection relations between them making
it suited for *object-centric* tasks. GeoGrapher also provides highly
general and customizable dataset cutting functionality as well as other
utility functions.
*GeoGrapher* is a Python library for building _object-centric_
machine learning datasets from remote sensing data—starting with a
list of objects (vector features such as locations or polygonal
segmentation masks) rather than a specific area. At its core,
GeoGrapher leverages a bipartite graph structure to efficiently
associate objects with relevant geospatial data, solving common
challenges in object-centric dataset construction. It provides
flexible, customizable cutting of large remote sensing rasters,
ensuring precise data extraction.

For a deeper dive, check out the [blog post](https://dida.do/blog/geographer-an-open-source-python-library-for-building-object-centric-machine-learning-datasets-from-remote-sensing-data)
or explore the [documentation](https://geographer.readthedocs.io/en/latest/).

# Installation
This package has two external dependencies:
Expand All @@ -34,9 +38,9 @@ pip install GeoGrapher
```

# Getting started
Read our our blogpost for an introduction to GeoGrapher, try out the tutorial
notebooks in the [notebooks directory](https://github.com/dida-do/GeoGrapher/tree/main/notebooks),
or read the documentation.
Here are several options for getting started:
- Try out the tutorial notebooks in the [notebooks directory](https://github.com/dida-do/GeoGrapher/tree/main/notebooks),
- Read the [documentation](https://geographer.readthedocs.io/en/latest/).

# Development
To create a local dev installation, clone the repo, `cd` into the repo folder,
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
author = "Rustam Antia"

# The full version, including alpha/beta/rc tags
release = "0.1.0"
release = "1.0.0"


# -- General configuration ---------------------------------------------------
Expand Down