Skip to content

Commit 16523a1

Browse files
committed
Add customization
1 parent 7f54c6c commit 16523a1

File tree

3 files changed

+26
-13
lines changed

3 files changed

+26
-13
lines changed

docs/authorization.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@ accounts you need to set up.
55

66
## `MAPBOX_TOKEN`
77

8-
Used to download the satellite images for both [creating a dataset](https://colab.research.google.com/github/mozilla-ai/osm-ai-helper/blob/main/demo/create_dataset.ipynb) and [running inference](https://colab.research.google.com/github/mozilla-ai/osm-ai-helper/blob/main/demo/run_inference.ipynb).
8+
Used to download the satellite images when [creating a dataset](https://colab.research.google.com/github/mozilla-ai/osm-ai-helper/blob/main/demo/create_dataset.ipynb) and/or [running inference](https://colab.research.google.com/github/mozilla-ai/osm-ai-helper/blob/main/demo/run_inference.ipynb).
9+
910
You need to:
1011

11-
- Createa an account: https://console.mapbox.com/
12+
- Create an account: https://console.mapbox.com/
1213
- Follow this guide to obtain your [Default Public Token](https://docs.mapbox.com/help/getting-started/access-tokens/#your-default-public-token).
1314

1415
## `OSM_CLIENT_ID` and `OSM_CLIENT_SECRET`
@@ -22,3 +23,12 @@ You need to:
2223
Grant `Modify the map (write_api)`.
2324
Set the redirect URL to `https://127.0.0.1:8000`.
2425
- Copy and save the `Client ID` and `Client Secret`.
26+
27+
## `HF_TOKEN`
28+
29+
Only needed if you are [Creating a Dataset](https://colab.research.google.com/github/mozilla-ai/osm-ai-helper/blob/main/demo/create_dataset.ipynb) and/or [Finetuning a Model](https://colab.research.google.com/github/mozilla-ai/osm-ai-helper/blob/main/demo/finetune_model.ipynb) in order to upload the results to the [HuggingFace Hub](https://huggingface.co/docs/hub/index).
30+
31+
You need to:
32+
33+
- Create an account: https://huggingface.co/join
34+
- Follow this guide about [`User Access Tokens`](https://huggingface.co/docs/hub/security-tokens)

docs/customization.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11
# 🎨 **Customization Guide**
22

3-
This Blueprint is designed to be flexible and easily adaptable to your specific needs. This guide will walk you through some key areas you can customize to make the Blueprint your own.
3+
This OpenStreetMap AI Helper Blueprint is designed to be flexible and easily adaptable to your specific needs. This guide will walk you through some key areas you can customize to make the Blueprint your own.
44

55
---
66

77
## 🧠 **Changing the Model**
88

9+
The default provided model is trained to detect swimming pools.
910

11+
You can follow the [Create Dataset](https://colab.research.google.com/github/mozilla-ai/osm-ai-helper/blob/main/demo/create_dataset.ipynb) and [Finetune Model](https://colab.research.google.com/github/mozilla-ai/osm-ai-helper/blob/main/demo/finetune_model.ipynb).
1012

11-
## 📝 **Modifying the system Prompt**
12-
13-
14-
15-
## 💡 Other Customization Ideas
16-
17-
- other ideas..
13+
When creating the dataset, you need to pick:
1814

15+
- A `selector` based on [OpenStreetMap tags](https://wiki.openstreetmap.org/wiki/Map_features).
16+
The example uses [`leisure=swimming_pool`](https://wiki.openstreetmap.org/wiki/Tag:leisure=swimming_pool).
17+
Try to pick elements that can be clearly delimited with a polygon and are easy to distinguish in the satellite images.
18+
A similar example would be a tenis court `leisure=pitch + sport=tennis`.
19+
- An appropriate [`zoom` level](https://docs.mapbox.com/help/glossary/zoom-level/) (the example uses `18`).
20+
There is a tradeoff between easier detection (higher zoom levels) and covering a wider area on each tile (lower zoom levels).
1921

2022
## 🤝 **Contributing to the Blueprint**
2123

docs/future-features-contributions.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@ This Blueprint is an evolving project designed to grow with the help of the open
1515

1616
This Blueprint is designed to be a foundation you can build upon. By extending its capabilities, you can open the door to new applications, improve user experience, and adapt the Blueprint to address other use cases. Here are a few ideas for how you can expand its potential:
1717

18-
19-
We’d love to see how you can enhance this Blueprint! If you create improvements or extend its capabilities, consider contributing them back to the project so others in the community can benefit from your work. Check out our [Contributions Guide](https://github.com/mozilla-ai/osm-ai-helper/blob/main/CONTRIBUTING.md) to get started!
18+
We'd love to see how you can enhance this Blueprint! If you create improvements or extend its capabilities, consider contributing them back to the project so others in the community can benefit from your work. Check out our [Contributions Guide](https://github.com/mozilla-ai/osm-ai-helper/blob/main/CONTRIBUTING.md) to get started!
2019

2120
### 💡 **Share Your Ideas**
22-
Got an idea for how this Blueprint could be improved? You can share your suggestions through [GitHub Discussions](https://github.com/mozilla-ai/osm-ai-helper/discussions).
21+
Got an idea for how this Blueprint could be improved? You can share your suggestions in Discord:
22+
23+
<a target="_blank" href="https://discord.gg/gazz5XDU"><img src="https://dcbadge.limes.pink/api/server/gazz5XDU" alt="" /></a>
2324

2425
### 🌍 **Build New Blueprints**
2526
This project is part of a larger initiative to create a collection of reusable starter code solutions that use open-source AI tools. If you’re inspired to create your own Blueprint, you can use the [blueprint-template](https://github.com/new?template_name=blueprint-template&template_owner=mozilla-ai) to get started.

0 commit comments

Comments
 (0)