ajstewart commited on
Commit
650dfe8
·
verified ·
1 Parent(s): 01ded20

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +27 -0
README.md CHANGED
@@ -7,3 +7,30 @@ sdk: static
7
  pinned: false
8
  ---
9
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  pinned: false
8
  ---
9
 
10
+ Welcome to the TorchGeo Hugging Face community!
11
+
12
+ TorchGeo uses Hugging Face to redistribute many of its datasets and model weights, providing fast, reliable, and reproducible downloads.
13
+
14
+ # Adding new datasets/models
15
+
16
+ If you would like to redistribute a new dataset/model via this community, it must satisfy [a couple criteria](https://github.com/torchgeo/governance/blob/main/CHARTER.md#8-project-criteria):
17
+
18
+ * Must be under an open source license. This excludes source available licenses like CC-BY-NC or OpenRAIL.
19
+ * Must be under a license that allows redistribution. We can't redistribute your dataset/model unless the authors give us permission.
20
+
21
+ Priority is given to datasets/models with existing or work-in-progress TorchGeo data loaders/models, but all datasets/models are welcome if they satisfy these criteria.
22
+
23
+ If your dataset/model follows these criteria, please follow the following steps:
24
+
25
+ 1. Upload the dataset/model to your own Hugging Face account.
26
+ 2. Make sure you clearly document the license, where the dataset/model came from, and any changes you made.
27
+ 3. Join the `#technical-steering-committee` channel of the [TorchGeo Slack](https://join.slack.com/t/torchgeo/shared_invite/zt-22rse667m-eqtCeNW0yI000Tl4B~2PIw).
28
+ 4. Post your request to onboard a new dataset/model. Provide a link to where the original license can be found.
29
+ 5. The [TSC](https://github.com/torchgeo/governance/blob/main/STEERING-COMMITTEE.md) will then vote to onboard your dataset/model. A simple majority vote is required.
30
+ 6. If the vote passes, we will contact you with instructions to transfer your repository to our community.
31
+
32
+ If you are unable or unwilling to use Slack, you can also post a request on https://github.com/torchgeo/torchgeo/discussions.
33
+
34
+ # Updating existing datasets/models
35
+
36
+ If you would like to make changes to an existing dataset/model (including one you recently added), please open a [pull request](https://huggingface.co/docs/hub/en/repositories-pull-requests-discussions) for the specific repository. You may also need to contact someone on the [TSC](https://github.com/torchgeo/governance/blob/main/STEERING-COMMITTEE.md) on GitHub or Slack, as we may not immediately see your pull request on Hugging Face.