Appearance
User Manual for fAIr
Welcome! This manual is your step-by-step guide to getting started with fAIr, the AI-assisted mapping platform from the Humanitarian OpenStreetMap Team (HOT).
Table of Contents
- Prerequisites
- Video Tutorials
- Creating a Project in fAIr
- Starting Mapping in Your Project
- Editing Model Predictions
- Help and Support
- Thank You
Prerequisites
- Stable internet connection
- Basic mapping knowledge (learn more)
- Basic understanding of AI datasets and models
- Account on fAIr
Video Tutorials
Watch our step-by-step video guides:
- Getting Started
- Creating Datasets
- Training Models
- Mapping with Predictions
- Feedback and Validation
- ...and more on our GitHub
Creating a Project in fAIr
- Log in to fAIr.
- Click Start Creating Dataset.
- Click Create New to make a new dataset.
- Name your dataset and click Create Training Dataset.
- Open OpenAerialMap in a new tab, find a suitable drone image, and copy its TMS URL.
- Paste the TMS URL into the Open Aerial Imagery tab in fAIr.
- Zoom to your image layer for visualization.
- Use the map tools to draw your Area of Interest (AOI).
- Click Fetch OSM Data to import existing building footprints for your AOI.
- Zoom in and review the imported buildings for accuracy.
- Edit and align building labels as needed for best training results.
- Upload your label fixes to OSM.
- Back in fAIr, fetch updated OSM labels for your AOI.
- On your dataset page, click View Models and then Create New to start a new model.
- Fill in model metadata and click Create AI Model.
- On the model page, submit a new training job with your chosen parameters.
- Monitor training progress and review accuracy graphs.
- Once satisfied, click Publish Training to make your model available for mapping.
Starting Mapping in Your Project
- On the model page, click Start Mapping next to your published training.
- Zoom to your area of interest and click Detect to run predictions.
- Review the AI-generated predictions on the map.
- Edit, accept, or discard predictions as needed.
- Push your validated results to OSM or export for further editing.
Editing Model Predictions
- Select a model and click Start Mapping to view predictions.
- Zoom in and review the predicted features.
- Accept or discard parts of the prediction, then re-run if needed.
- After making changes, click Submit my Feedback.
- All feedback is reviewed and validated by the project manager.
Note: Each "task" refers to a section of the map outlined with dotted lines and a number tag.
Help and Support
If you need help:
- Check the FAQs
- Join our Slack channel
- Open an issue on GitHub
Thank You
Thank you for joining the fAIr community!
Your mapping efforts help create detailed, up-to-date maps that support crisis response, infrastructure planning, and community resilience worldwide.
By mapping with fAIr, you’re part of a global network of volunteers using open data and AI to make a positive impact.
Explore projects, join tasks, and connect with fellow mappers. Your contributions are invaluable!
Happy mapping!
The fAIr Team