Better README (#626)

* Better README * Update description
microsoft · Jun 30, 2022 · 627473c · 627473c
1 parent a3d6e9f
commit 627473c
Show file tree

Hide file tree

Showing 8 changed files with 83 additions and 59 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -17,6 +17,6 @@ preferred-citation:
     given-names: "Arindam"
   journal: "arXiv preprint arXiv:2111.08872"
   month: 11
-  title: "TorchGeo: deep learning with geospatial data"
+  title: "TorchGeo: Deep Learning With Geospatial Data"
   url: "https://github.com/microsoft/torchgeo"
   year: 2021
diff --git a/README.md b/README.md
diff --git a/images/geodataset.png b/images/geodataset.png
diff --git a/images/inria.png b/images/inria.png
diff --git a/images/vhr10.png b/images/vhr10.png
diff --git a/pyproject.toml b/pyproject.toml
@@ -27,7 +27,7 @@ color_output = true
 [tool.mypy]
 ignore_missing_imports = true
 show_error_codes = true
-exclude = "(build|data|dist|docs/src|logo|logs|output)/"
+exclude = "(build|data|dist|docs/src|images|logo|logs|output)/"
 
 # Strict
 warn_unused_configs = true

diff --git a/setup.cfg b/setup.cfg
@@ -4,7 +4,7 @@ name = torchgeo
 version = attr: torchgeo.__version__
 author = Adam J. Stewart
 author_email = ajstewart426@gmail.com
-description = TorchGeo: datasets, transforms, and models for geospatial data
+description = TorchGeo: datasets, samplers, transforms, and pre-trained models for geospatial data
 long_description = file: README.md
 long_description_content_type = text/markdown
 url = https://github.com/microsoft/torchgeo
@@ -21,7 +21,7 @@ classifiers =
     Operating System :: OS Independent
     Topic :: Scientific/Engineering :: Artificial Intelligence
     Topic :: Scientific/Engineering :: GIS
-keywords = pytorch, deep learning, machine learning, remote sensing, satellite imagery, geospatial
+keywords = pytorch, deep learning, machine learning, remote sensing, satellite imagery, earth observation, geospatial
 
 [options]
 install_requires =
@@ -134,6 +134,7 @@ extend-ignore =
 exclude =
     # TorchGeo
     data/,
+    images/,
     logo/,
     logs/,
     output/,

diff --git a/torchgeo/__init__.py b/torchgeo/__init__.py
@@ -1,7 +1,7 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
-"""TorchGeo: datasets, transforms, and models for geospatial data.
+"""TorchGeo: datasets, samplers, transforms, and pre-trained models for geospatial data.
 
 This library is part of the `PyTorch <http://pytorch.org/>`_ project. PyTorch is an open
 source machine learning framework.